Skip to main content
GET
List organizations (BO, paginated/filterable)

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1
Required range: 0 < x <= 9007199254740991
pageSize
integer
default:50
Required range: 0 < x <= 1000
countOnly
boolean

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.

Example:

true

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

Case-insensitive search across name, comment and address.

Maximum string length: 200
Example:

"lobby"

whereName
string

Case-insensitive partial match on the organization name.

Maximum string length: 200
Example:

"lobby"

whereComment
string

Case-insensitive partial match on the comment.

Maximum string length: 200
Example:

"lobby"

whereTimezone
string

Case-insensitive partial match on the timezone.

Maximum string length: 200
Example:

"lobby"

whereType
string[]

Filter by one or more types (rs, ad).

Example:
whereLanguage
string[]

Filter by one or more languages (fr, en, de).

Example:
whereContractType
string[]

Filter by one or more contract types.

Example:
whereOnboardingStatus
string[]

Filter by one or more onboarding statuses.

Example:
whereAccessStatus
string[]

Filter by one or more access statuses (active, inactive).

Example:
whereUploadSizeLimit
integer[]

Filter by one or more upload-size limits (MB).

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
whereEngagementDuration
integer[]

Filter by one or more engagement durations (months).

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
whereCreatedByBoUserId
string<uuid>

Filter by the creator (BO admin) id.

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)$
whereEngagementStartAt
object

Filter by engagement start date range.

Example:
whereEngagementEndAt
object

Filter by engagement end date range.

Example:
whereRenewAt
object

Filter by renewal date range.

Example:
whereOnboardingUpdatedAt
object

Filter by onboarding-status change date range.

Example:
whereAccessStatusUpdatedAt
object

Filter by access-status change date range.

Example:
whereCreatedAt
object

Filter by creation date range.

Example:
whereUpdatedAt
object

Filter by last-update date range.

Example:
whereIncludeDeleted

When true, also returns soft-deleted organizations.

Example:

true

whereArchived

When true, only archived organizations; when false, only non-archived.

Example:

true

Response

Default Response

data
object[]
required
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
pagination
object
required