Skip to main content

GET /v1.1/ship

Returns a paginated list of all ships, with their related company data included.

Request

GET /v1.1/ship

Headers

HeaderRequiredDescription
X-WorldTravel-ApiKeyYesAPI key for authentication

Query Parameters

ParameterTypeDefaultDescription
page[number]integer1Page number (one-indexed)
page[size]integer10Items per page (max 1000)

Example Request

curl -X GET "https://api.rccl.ro/v1.1/ship?page[number]=1&page[size]=10" \
-H "X-WorldTravel-ApiKey: YOUR_API_KEY"

Response

200 OK

Returns an array of ship resources with related company objects included.

Response body:

{
"data": [
{
"type": "ship",
"id": "1",
"attributes": {
"code": "AL",
"title": "Allure of the Seas",
"description": "One of the world's largest cruise ships",
"image_url": "https://example.com/images/allure-thumb.jpg",
"hero_url": "https://example.com/images/allure-hero.jpg",
"inauguration": 2010,
"revitalization": 2020,
"capacity": 5400,
"crew": 2200,
"decks": 16,
"speed": "22 knots"
},
"relationships": {
"company": {
"links": {
"related": "/v1.1/company/1"
},
"data": {
"type": "company",
"id": "1"
}
}
},
"links": {
"self": "/v1.1/ship/1"
}
}
],
"links": {
"self": "/v1.1/ship",
"first": "/v1.1/ship?page[number]=1&page[size]=10",
"next": "/v1.1/ship?page[number]=2&page[size]=10"
},
"meta": {
"count": 25
},
"included": [
{
"type": "company",
"id": "1",
"attributes": {
"code": "RCI",
"title": "Royal Caribbean International",
"description": "Global cruise line",
"hero_url": "https://example.com/images/rci-hero.jpg",
"logo_url": "https://example.com/images/rci-logo.png",
"site_url": "https://www.royalcaribbean.com",
"terms_of_service_url": "https://example.com/terms",
"non_refundability_terms_url": "https://example.com/refund-terms",
"gratuities_included": true,
"dining_description": "Complimentary dining in the main restaurant",
"dining_image_url": "https://example.com/images/dining.jpg",
"gratuity_description": "Gratuities are included in the fare",
"gratuity_image_url": "https://example.com/images/gratuity.jpg",
"deck_legend_url": "https://example.com/images/deck-legend.png"
},
"links": {
"self": "/v1.1/company/1"
}
}
],
"jsonapi": {
"version": "1.0"
}
}

Ship Attributes

FieldTypeDescription
codestringUnique ship code
titlestringShip name
descriptionstringShip description
image_urlstringThumbnail image URL
hero_urlstringHero/banner image URL
inaugurationintegerYear the ship was inaugurated
revitalizationintegerYear of last revitalization
capacityintegerMaximum passenger capacity
crewintegerNumber of crew members
decksintegerNumber of decks
speedstringMaximum speed

Relationships

RelationshipTypeDescription
companycompanyThe cruise line operating this ship

Included Resources

The response includes related company objects. See the company attributes:

FieldTypeDescription
codestringCompany code
titlestringCompany name
descriptionstringCompany description
hero_urlstringHero image URL
logo_urlstringLogo image URL
site_urlstringCompany website URL
terms_of_service_urlstringTerms of service URL
non_refundability_terms_urlstringNon-refundability terms URL
gratuities_includedbooleanWhether gratuities are included in fares
dining_descriptionstringDining information
dining_image_urlstringDining image URL
gratuity_descriptionstringGratuity policy description
gratuity_image_urlstringGratuity image URL
deck_legend_urlstringDeck legend image URL

Error Responses

StatusDescription
401Unauthorized — missing or invalid API key
500Internal Server Error — upstream query failure