List caravans

get/caravans
Returns a paginated list of all caravans operated by your trading company.

Query Parameters

pageinteger

Page number (1-based)

Default: 1

per_pageinteger

Number of results per page (max 100)

Default: 20

statusstring ("forming" | "ready" | "in_transit" | "arrived" | "resting" | "retired")

Filter by caravan status

Responses

200OK

application/json

itemsarray of Caravan
idstringrequired

Unique caravan identifier

namestringrequired

Human-readable caravan name

descriptionstring

Optional description of the caravan

routestring ("sahara_crossing" | "oasis_loop" | "silk_road_west" | "nile_delta" | "atlas_pass")

Assigned trade route

statusstring ("forming" | "ready" | "in_transit" | "arrived" | "resting" | "retired")required

Current lifecycle status

camel_countinteger

Number of camels assigned to the caravan

lead_trader_namestring

Name of the trader responsible for the caravan

origin_marketstring

Market where the caravan begins its route

destination_marketstring

Primary market destination for the caravan

scheduled_departure_atstring (date-time)

Planned departure time for the caravan

estimated_arrival_atstring (date-time)

Estimated arrival time at the destination market

manifest_idstring

Active cargo manifest assigned to the caravan

created_atstring (date-time)required

When the caravan was created

updated_atstring (date-time)

When the caravan was last updated

totalinteger

Total number of caravans

pageinteger

Current page number

per_pageinteger

Results per page

has_moreboolean

Whether another page of results is available

next_pageinteger

Next page number, if more results are available

request_idstring

Unique request identifier for support and tracing

Errors