> ## 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. # List organizations (BO, paginated/filterable) ## OpenAPI ````yaml /api/bo/openapi.json get /bo/organizations/v1/ 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/: get: tags: - organizations summary: List organizations (BO, paginated/filterable) operationId: listOrganizationsBOV1 parameters: - schema: default: 1 type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 in: query name: page required: false - schema: default: 50 type: integer minimum: 0 exclusiveMinimum: true maximum: 1000 in: query name: pageSize required: false - schema: example: true anyOf: - type: boolean in: query name: countOnly required: false description: >- When true, answers `totalCount` with an empty `data`: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter. - 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 } per row. - "updatable-fields": Adds `updatableFields` (per-field editability, type-aware) per row. - "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: array items: type: object properties: field: type: string enum: - name - type - language - timezone - contractType - onboardingStatus - accessStatus - uploadSizeLimit - engagementDuration - engagementStartAt - engagementEndAt - renewAt - memberCount - createdAt - updatedAt description: >- OrderBy options (JSON-encoded array, e.g. `?orderBy=[{"field":"name","direction":"asc"}]`): - "name": Order by organization name. - "type": Order by type. - "language": Order by language. - "timezone": Order by timezone. - "contractType": Order by contract type. - "onboardingStatus": Order by onboarding status. - "accessStatus": Order by access status. - "uploadSizeLimit": Order by upload-size limit. - "engagementDuration": Order by engagement duration. - "engagementStartAt": Order by engagement start date. - "engagementEndAt": Order by engagement end date. - "renewAt": Order by renewal date. - "memberCount": Order by number of members (users). - "createdAt": Order by creation date. - "updatedAt": Order by last-update date. direction: type: string enum: - asc - desc description: Sort direction example: asc required: - field - direction in: query name: orderBy required: false - schema: type: string maxLength: 200 example: lobby in: query name: whereSearch required: false description: Case-insensitive search across name, comment and address. - schema: type: string maxLength: 200 example: lobby in: query name: whereName required: false description: Case-insensitive partial match on the organization name. - schema: type: string maxLength: 200 example: lobby in: query name: whereComment required: false description: Case-insensitive partial match on the comment. - schema: type: string maxLength: 200 example: lobby in: query name: whereTimezone required: false description: Case-insensitive partial match on the timezone. - schema: type: array items: type: string example: - rs - ad in: query name: whereType required: false description: Filter by one or more types (rs, ad). - schema: type: array items: type: string example: - fr-FR - en-US in: query name: whereLanguage required: false description: Filter by one or more languages (fr, en, de). - schema: type: array items: type: string example: - kare - kare_pilot in: query name: whereContractType required: false description: Filter by one or more contract types. - schema: type: array items: type: string example: - pending - in_progress in: query name: whereOnboardingStatus required: false description: Filter by one or more onboarding statuses. - schema: type: array items: type: string example: - active - inactive in: query name: whereAccessStatus required: false description: Filter by one or more access statuses (active, inactive). - schema: type: array items: type: integer minimum: -9007199254740991 maximum: 9007199254740991 example: - 1 - 2 - 3 in: query name: whereUploadSizeLimit required: false description: Filter by one or more upload-size limits (MB). - schema: type: array items: type: integer minimum: -9007199254740991 maximum: 9007199254740991 example: - 1 - 2 - 3 in: query name: whereEngagementDuration required: false description: Filter by one or more engagement durations (months). - 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: query name: whereCreatedByBoUserId required: false description: Filter by the creator (BO admin) id. - schema: anyOf: - type: object properties: start: type: string end: type: string - type: object properties: gte: type: string lte: type: string example: start: '2026-01-01' end: '2026-01-31' in: query name: whereEngagementStartAt required: false description: Filter by engagement start date range. - schema: anyOf: - type: object properties: start: type: string end: type: string - type: object properties: gte: type: string lte: type: string example: start: '2026-01-01' end: '2026-01-31' in: query name: whereEngagementEndAt required: false description: Filter by engagement end date range. - schema: anyOf: - type: object properties: start: type: string end: type: string - type: object properties: gte: type: string lte: type: string example: start: '2026-01-01' end: '2026-01-31' in: query name: whereRenewAt required: false description: Filter by renewal date range. - schema: anyOf: - type: object properties: start: type: string end: type: string - type: object properties: gte: type: string lte: type: string example: start: '2026-01-01' end: '2026-01-31' in: query name: whereOnboardingUpdatedAt required: false description: Filter by onboarding-status change date range. - schema: anyOf: - type: object properties: start: type: string end: type: string - type: object properties: gte: type: string lte: type: string example: start: '2026-01-01' end: '2026-01-31' in: query name: whereAccessStatusUpdatedAt required: false description: Filter by access-status change date range. - schema: anyOf: - type: object properties: start: type: string end: type: string - type: object properties: gte: type: string lte: type: string example: start: '2026-01-01' end: '2026-01-31' in: query name: whereCreatedAt required: false description: Filter by creation date range. - schema: anyOf: - type: object properties: start: type: string end: type: string - type: object properties: gte: type: string lte: type: string example: start: '2026-01-01' end: '2026-01-31' in: query name: whereUpdatedAt required: false description: Filter by last-update date range. - schema: anyOf: - type: boolean - type: string example: true in: query name: whereIncludeDeleted required: false description: When `true`, also returns soft-deleted organizations. - schema: anyOf: - type: boolean - type: string example: true in: query name: whereArchived required: false description: >- When `true`, only archived organizations; when `false`, only non-archived. responses: '200': description: Default Response content: application/json: schema: type: object properties: data: type: array items: 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 totalCount: type: integer minimum: 0 maximum: 9007199254740991 pagination: type: object properties: page: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 pageSize: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 totalPages: type: integer minimum: 0 maximum: 9007199254740991 required: - page - pageSize - totalPages additionalProperties: false required: - data - totalCount - pagination 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 ````