List Ships - Seamind

GET

api

shared

ships

List Ships

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

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "imoNumber": "<string>",
      "mmsiNumber": "<string>",
      "callSign": "<string>",
      "flagName": "<string>",
      "portOfRegistry": "<string>",
      "crewCount": 0
    }
  ],
  "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

ShipDetailDTO · object[]

required

Show child attributes

nextCursor

string | null

hasMore

boolean

default:false

totalCount

integer | null

Create ShipCreate a new ship in the admin's organization. Requires admin role.

List Ships

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

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "imoNumber": "<string>",
      "mmsiNumber": "<string>",
      "callSign": "<string>",
      "flagName": "<string>",
      "portOfRegistry": "<string>",
      "crewCount": 0
    }
  ],
  "nextCursor": "<string>",
  "hasMore": false,
  "totalCount": 123
}