Skip to main content
GET
/
api
/
v1
/
ships
List Ships
curl --request GET \
  --url https://api.seamind.xyz/api/v1/ships/ \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "imoNumber": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "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

search
string | null

Search term

Maximum string length: 200
include_count
boolean
default:false

Include total count

Response

Successful Response

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