Skip to main content
GET
/
api
/
v1
/
customer
/
offerings
List Offerings
curl --request GET \
  --url https://api.example.com/api/v1/customer/offerings
{
  "data": [
    {
      "tripItineraryId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "tripId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
      "fromStopId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c",
      "toStopId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d",
      "price": 15000,
      "fromStop": {
        "tripStopId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
        "tripId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
        "pointId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c",
        "stopOrder": 1,
        "point": {
          "pointId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
          "name": "São Paulo",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z",
          "description": "Terminal Rodoviário Tietê",
          "lat": -23.5155,
          "lng": -46.6254
        },
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "arrivalAt": "2026-04-15T10:00:00.000Z",
        "departureAt": "2026-04-15T10:15:00.000Z"
      },
      "toStop": {
        "tripStopId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
        "tripId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
        "pointId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c",
        "stopOrder": 1,
        "point": {
          "pointId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
          "name": "São Paulo",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z",
          "description": "Terminal Rodoviário Tietê",
          "lat": -23.5155,
          "lng": -46.6254
        },
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "arrivalAt": "2026-04-15T10:00:00.000Z",
        "departureAt": "2026-04-15T10:15:00.000Z"
      },
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "availableSeats": 12,
      "availableSeatsStatus": "AVAILABLE",
      "trip": {
        "tripId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
        "companyId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
        "routeId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c",
        "vehicleId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d",
        "driverId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e",
        "status": "SCHEDULED",
        "events": [
          {
            "tripEventId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
            "tripId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b",
            "type": "DEPARTURE_DELAYED",
            "createdAt": "2026-01-01T00:00:00.000Z",
            "updatedAt": "2026-01-01T00:00:00.000Z",
            "tripStopId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c",
            "description": "Departure delayed by 15 minutes due to traffic",
            "metadata": {}
          }
        ],
        "departureAt": "2026-04-15T08:00:00.000Z",
        "estimatedArrivalAt": "2026-04-15T14:00:00.000Z",
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "company": {
          "companyId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
          "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
          "organization": {
            "name": "Viação Estrela Ltda.",
            "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
            "logo": "organizations/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/logo/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png"
          }
        }
      }
    }
  ],
  "meta": {
    "limit": 10,
    "page": 1,
    "totalItems": 142,
    "totalPages": 15
  }
}

Query Parameters

​
limit
number
default:10

Items per page

Example:

10

​
nextCursor
string

Cursor to end before

Example:

"123"

​
previousCursor
string

Cursor to start after

Example:

"123"

​
filter
string

Free-text filter over origin and destination names

Example:

"São Paulo"

​
originPointId
string<uuid>

Origin point identifier

​
destinationPointId
string<uuid>

Destination point identifier

​
originName
string

Origin name or description

Example:

"São Paulo"

​
destinationName
string

Destination name or description

Example:

"Rio de Janeiro"

​
departureFrom
string<date-time>

Departure date from

Example:

"2026-04-15T00:00:00.000Z"

​
departureTo
string<date-time>

Departure date to

Example:

"2026-04-16T00:00:00.000Z"

​
sortBy
enum<string>
default:departureAt

Field to sort by

Available options:
departureAt,
price,
createdAt
Example:

"departureAt"

​
sortOrder
enum<string>
default:asc

Sort order

Available options:
asc,
desc
Example:

"asc"

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

​
data
object[]
required
​
meta
object
required

Page-based pagination metadata.