Get Current User Assignments

GET

api

shared

users

assignments

Get Current User Assignments

curl --request GET \
  --url https://api.example.com/api/v1/shared/users/me/assignments \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "shipName": "<string>",
      "role": "<string>",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "isActive": true,
      "shipImoNumber": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": false,
  "totalCount": 123
}

Authorizations

Authorization

string

header

required

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

Query Parameters

limit

integer

default:10

Items per page

Required range: 1 <= x <= 1000

cursor

string | null

Pagination cursor

string | null

Search term

Maximum string length: 200

include_count

boolean

default:false

Include total count

Response

Successful Response

items

AssignmentWithShipDTO · object[]

required

Show child attributes

nextCursor

string | null

hasMore

boolean

default:false

totalCount

integer | null

Get Current User CoursesGet all courses assigned to the current user via assignment_courses. Returns courses with full context (status, assignment, ship, curriculum). Courses are sourced from assignment_courses table, with registration status joined when available (None if course not yet started). By default, only includes courses from active assignments (not ended). Use include_past=true to include courses from ended assignments.

Get Current User Assignments

curl --request GET \
  --url https://api.example.com/api/v1/shared/users/me/assignments \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "shipName": "<string>",
      "role": "<string>",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "isActive": true,
      "shipImoNumber": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": false,
  "totalCount": 123
}