Skip to main content
GET
/
api
/
v1
/
shared
/
ships
/
{ship_id}
Get Ship
curl --request GET \
  --url https://api.example.com/api/v1/shared/ships/{ship_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "imo_number": "<string>",
  "mmsi_number": "<string>",
  "call_sign": "<string>",
  "flag_name": "<string>",
  "port_of_registry": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
ship_id
string<uuid>
required

Query Parameters

​
expand
boolean
default:false

Include enriched data (crew_count)

Response

Successful Response

Ship data transfer object - returned from repositories. Represents a ship as stored in the database.

​
id
string<uuid>
required
​
organization_id
string<uuid>
required
​
name
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
imo_number
string | null
​
mmsi_number
string | null
​
call_sign
string | null
​
flag_name
string | null
​
port_of_registry
string | null