Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cabify Journeys API

This section covers the mobility solution for all companies looking to transport their employees in a simple, safe and comfortable way. We offer different types of vehicles with private drivers and provide everything you need to enjoy your journey, such as a good driver and a top-of-the-range car.

Cabify Journeys API is one of 13 APIs that Cabify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Journeys. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and a changelog.

This API exposes 5 operations across 4 paths, and defines 23 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 2 base URLs: https://logistics.api.cabify.com, https://logistics.api.cabify-sandbox.com.

5 operations 4 paths 23 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://cabify.com/api/v4
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Cabify Journeys API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer_token).

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Journeys 5

This section covers the mobility solution for all companies looking to transport their employees in a simple, safe and comfortable way. We offer different types of vehicles with p…

POST
/api/v4/journey/{id}/state
Cancel Journey
cancelJourney 1 param → 200400401409500
GET
/api/v4/journey/{id}/state
Get Journey State
getJourneyState 2 params → 200400401404500
POST
/api/v4/journey
Create a journey
createJourney body → 200400401404500
GET
/api/v4/journey/{journey_id}
Get Journey details
getJourney 1 param → 200400401500
POST
/api/v4/journey/{id}/keep_searching
Keep searching drivers for a journey
keepSearching 1 param → 204400401404500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Journey (15 properties), StopResponse (13 properties), StopRequest (12 properties), JourneyRequest (9 properties). Each schema is shown below with its type and property counts.

MeetingPoint
object
A specific meeting point within a hub location (e.g. a terminal at an airport). Obtained from the hub data returned in the estimates response.
3 properties 3 required
BadRequest
object
Indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax…
1 property
InternalServerError
object
indicates that an internal server error occurred
1 property
UnauthorizedRequest
object
The token used is invalid either because it is expired or because it is incorrect.
1 property
Journey
object
Booking-level details of a journey including stops, pricing, timestamps, and lifecycle status.
15 properties 1 required
Price
object
Price in the currency smallest unit.
2 properties
Driver
object
Driver's information.
4 properties
Mobile
object
Input Mobile Number. Required when the rider is external. Journey's SMS state updates will arrive to this mobile.
2 properties 2 required
JourneyRequest
object
Input object needed to create a new journey. ⚠️ Always estimate before creating a journey You must call /estimates before creating a journey. The estimation re…
9 properties 4 required
Conflict
object
The request conflicts with the current state of the resource. For journey cancellation, this means the journey has already been cancelled, terminated, or is in…
1 property
JourneyResponse
object
1 property
PreassignedDriver
object
Driver preassigned to the journey (for example on a reservation) before the journey is actually assigned. It does not include the phone number, and it may chan…
3 properties
Rider
object
Input data defining the rider of a journey.
5 properties
StopResponse
object
Stop of a journey. A journey needs to have at least 2 stops: the first one is considered the pickup point the last one the destination.
13 properties 1 required
Row
object
Point and state through which the driver passed during the journey.
2 properties
NotFound
object
The server did not find a current representation for the target resource
1 property
Totals
object
Price breakdown for the journey. Only populated after the journey reaches terminated state.
3 properties
StopRequest
object
Stop of a journey. A journey needs to have at least 2 stops: the first one is considered the pickup point the last one the destination.
12 properties 1 required
JourneyState
object
Real-time operational state of an active journey: the assigned driver, their vehicle, and the route waypoints recorded so far.
7 properties
Contact
object
Contact details on each Stop. Include this object if you want the Driver to see additional Contact details on each Stop.
4 properties
Vehicle
object
Journey's vehicle information.
3 properties
Waypoint
object
Information about the different points through which the driver passed during the journey.
2 properties
DriverStopBeforePickup
object
Best-effort location where the driver is heading before coming to the pickup. May be null even when isdriveronanotherjourney is true.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cabify-journeys-api-openapi.yml Raw ↑

Other APIs Cabify publishes across the network.

Cabify delivery API
Cabify Estimates API
Cabify hubs API
Cabify label API
Cabify Labels API
Cabify parcels API
Cabify Sales API
Cabify shipment API
Cabify shipping_types API
Cabify status API
Cabify users API
Cabify webhooks API