Skip to main content
GET
Get Assignment

Authorizations

Authorization
string
header
required

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

Path Parameters

assignment_id
string<uuid>
required

Query Parameters

expand
boolean
default:false

Include enriched data (user/ship names)

Response

Successful Response

Assignment data transfer object - returned from repositories. Represents a user's assignment to a ship.

id
string<uuid>
required
organization_id
string<uuid>
required
user_id
string<uuid>
required
ship_id
string<uuid>
required
role
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
start_date
string<date> | null
end_date
string<date> | null