Skip to main content
GET
Get an organization by id (BO)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required
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)$

Query Parameters

extend
enum<string>[]

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.
Available options:
member-count,
actions-info,
updatable-fields,
created-by,
ai-config

Response

Default Response

id
string<uuid>
required
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
enum<string>
required
Available options:
rs,
ad
name
string
required
Required string length: 1 - 100
comment
string | null
required
Maximum string length: 1000
language
enum<string>
required
Available options:
fr-FR,
en-US,
de-DE
timezone
string
required
Required string length: 1 - 100
uploadSizeLimit
integer
required
Required range: 0 <= x <= 1048576
uploadSizeUsed
integer
required
Required range: 0 <= x <= 9007199254740991
engagementDuration
integer | null
required
Required range: 0 < x <= 600
engagementStartAt
string<date-time> | null
required
engagementEndAt
string<date-time> | null
required
renewAt
string<date-time> | null
required
contractType
enum<string>
required
Available options:
kare,
kare_pilot,
kare_with_monitoring,
kare_with_rus
onboardingStatus
enum<string>
required
Available options:
pending,
in_progress,
blocked,
training,
ready_to_send,
closed
onboardingUpdatedAt
string<date-time>
required
accessStatus
enum<string>
required
Available options:
active,
inactive
accessStatusUpdatedAt
string<date-time>
required
inboundAlias
string | null
required
Pattern: ^[a-z0-9]{3,64}$
createdByBoUserId
string<uuid> | null
required
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
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
addressCountry
string | null
required
Required string length: 1 - 200
addressCity
string | null
required
Required string length: 1 - 200
addressPostalCode
string | null
required
Required string length: 1 - 20
addressStreet
string | null
required
Required string length: 1 - 200
memberCount
integer
Required range: 0 <= x <= 9007199254740991
actions
object
updatableFields
object
createdByBoUser
object | null
aiProvider
enum<string> | null
Available options:
anthropic,
mistral
aiModel
string | null
Required string length: 1 - 100
aiSearchEnabled
boolean