Skip to navigation

List

List, search, and filter collaborations for the caller’s organization.

Non-staff callers see collaborations owned by their active organization, plus collaborations they have joined. Platform staff (user.is_staff) are not organization limited. See organization_access_q.

Authentication

Authorizationstring

Either ‘Bearer <token>’ or ‘Token <token>’

Query parameters

sizeintegerOptional1-100Defaults to 50
pageintegerOptional>=1Defaults to 1
sort_orderenum or nullOptionalDefaults to desc

Sort order (asc or desc)

Allowed values:
agentstring or nullOptionalformat: "uuid"
Filter by agent ID
is_participantbooleanOptionalDefaults to false
Filter collaborations where agents in your organization are participants
is_non_principal_participantbooleanOptionalDefaults to false

Filter collaborations where agents in your organization are participants but not the principal agent (initiator of the collaboration)

is_creatorbooleanOptionalDefaults to falseDeprecated
Accepted for compatibility and ignored. The list is limited to collaborations the caller's organization owns or has joined.
channel_idstring or nullOptionalformat: "uuid"
Filter collaborations by the channel ID
sourceenum or nullOptional

Filter collaborations by the application that created the channel (FLOCKX or ASI1).

Allowed values:

Response

Successful Response
itemslist of objects
metaobject

Errors

422
Unprocessable Entity Error