Skip to main content
POST
ListCrewProfiles

Authorizations

Authorization
string
header
required

Personal API key, sent as Authorization: Bearer <key>.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json

Request to list crew profiles for an organization

organizationId
string<uuid>

id of the organization to which the crew profiles belong

paging
paging · object

describes how the client would like to have pagination

showArchived
boolean | null

when true, show only archived crew profiles instead of active ones

Response

Success

Response for listing crew profiles

items
ListCrewProfilesItem · object[]

list of crew profile items

paging
paging · object

paging information for the response