Skip to main content
GET
List Crew Roster

Authorizations

Authorization
string
header
required

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

Query Parameters

role
string | null

Filter by cached role

state
string | null

Filter by account state

verification_state
string | null

Filter by profile verification rollup state

assignment_status
string | null

Filter by ship-assignment status (assigned | unassigned)

limit
integer
default:10

Items per page

Required range: 1 <= x <= 1000
cursor
string | null

Pagination cursor

search
string | null

Search term

Maximum string length: 200
include_count
boolean
default:false

Include total count

Response

Successful Response

items
CrewRosterItemDTO · object[]
required
nextCursor
string | null
hasMore
boolean
default:false
totalCount
integer | null