> ## Documentation Index > Fetch the complete documentation index at: https://api-documentation.kare-app.fr/llms.txt > Use this file to discover all available pages before exploring further. # Get an organization by id (BO) ## OpenAPI ````yaml /api/bo/openapi.json get /bo/organizations/v1/{id} openapi: 3.0.3 info: title: KARE API description: Backend API for the KARE platform version: dev servers: - url: http://localhost:3000 description: Local dev security: [] tags: - name: better-auth description: >- Better Auth's own endpoints (sign-in, session, MFA, password) - generated from the audience's live config via `generateOpenAPISchema()`, not hand-written. paths: /bo/organizations/v1/{id}: get: tags: - organizations summary: Get an organization by id (BO) operationId: getOrganizationBOV1 parameters: - schema: type: array items: type: string enum: - member-count - actions-info - updatable-fields - created-by - ai-config description: >- Extend options (JSON-encoded array, e.g. `?extend=["category"]`): - "member-count": Adds `memberCount` (number of users in the organization). - "actions-info": Adds `actions` { canBeUpdated, canBeDeleted }. - "updatable-fields": Adds `updatableFields` (per-field editability, type-aware). - "created-by": Adds `createdByBoUser` { id, name, email } (the BO admin who created the org). - "ai-config": Adds the AI configuration { aiProvider, aiModel, aiSearchEnabled }. AI Search activation is BO-owned. in: query name: extend required: false - schema: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ type: type: string enum: - rs - ad name: type: string minLength: 1 maxLength: 100 comment: nullable: true type: string maxLength: 1000 language: type: string enum: - fr-FR - en-US - de-DE timezone: type: string minLength: 1 maxLength: 100 uploadSizeLimit: type: integer minimum: 0 maximum: 1048576 uploadSizeUsed: type: integer minimum: 0 maximum: 9007199254740991 engagementDuration: nullable: true type: integer minimum: 0 exclusiveMinimum: true maximum: 600 engagementStartAt: nullable: true type: string format: date-time engagementEndAt: nullable: true type: string format: date-time renewAt: nullable: true type: string format: date-time contractType: type: string enum: - kare - kare_pilot - kare_with_monitoring - kare_with_rus onboardingStatus: type: string enum: - pending - in_progress - blocked - training - ready_to_send - closed onboardingUpdatedAt: type: string format: date-time accessStatus: type: string enum: - active - inactive accessStatusUpdatedAt: type: string format: date-time inboundAlias: nullable: true type: string pattern: ^[a-z0-9]{3,64}$ createdByBoUserId: nullable: true type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ archivedAt: nullable: true type: string format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time addressCountry: nullable: true type: string minLength: 1 maxLength: 200 addressCity: nullable: true type: string minLength: 1 maxLength: 200 addressPostalCode: nullable: true type: string minLength: 1 maxLength: 20 addressStreet: nullable: true type: string minLength: 1 maxLength: 200 memberCount: type: integer minimum: 0 maximum: 9007199254740991 actions: type: object properties: canBeUpdated: type: boolean canBeArchived: type: boolean canBeUnarchived: type: boolean canBeDeleted: type: boolean canSetAccessStatus: type: boolean required: - canBeUpdated - canBeArchived - canBeUnarchived - canBeDeleted - canSetAccessStatus additionalProperties: false updatableFields: type: object properties: name: type: boolean comment: type: boolean language: type: boolean timezone: type: boolean uploadSizeLimit: type: boolean contractType: type: boolean engagementDuration: type: boolean engagementStartAt: type: boolean onboardingStatus: type: boolean address: type: boolean required: - name - comment - language - timezone - uploadSizeLimit - contractType - engagementDuration - engagementStartAt - onboardingStatus - address additionalProperties: false createdByBoUser: nullable: true type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ name: type: string email: type: string required: - id - name - email additionalProperties: false aiProvider: nullable: true type: string enum: - anthropic - mistral aiModel: nullable: true type: string minLength: 1 maxLength: 100 aiSearchEnabled: type: boolean required: - id - type - name - comment - language - timezone - uploadSizeLimit - uploadSizeUsed - engagementDuration - engagementStartAt - engagementEndAt - renewAt - contractType - onboardingStatus - onboardingUpdatedAt - accessStatus - accessStatusUpdatedAt - inboundAlias - createdByBoUserId - archivedAt - createdAt - updatedAt - addressCountry - addressCity - addressPostalCode - addressStreet additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: error: type: string message: type: string requestId: type: string details: {} required: - error - message - requestId additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: error: type: string message: type: string requestId: type: string details: {} required: - error - message - requestId additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: error: type: string message: type: string requestId: type: string details: {} required: - error - message - requestId additionalProperties: false ````