Skip to main content
GET
/
api
/
v1
/
learn
/
assignments
/
{assignment_id}
Get Assignment
curl --request GET \
  --url https://api.example.com/api/v1/learn/assignments/{assignment_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ship_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25"
}

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