List trip summaries for travelers managed by an arranger

Request

Retrieves the list of trip summaries for all travelers managed by a specific arranger. This endpoint can be used for arrangers whose role types are COMPANY_TRAVEL_ARRANGER or TRAVEL_ARRANGER.

Security

Bearer

Path

arrangerIdstring, (uuid)required

Identifier for the arranger whose managed travelers trip summaries are requested.

Example:4974a66b-7493-4f41-908c-58ba81093947

Bodyapplication/jsonrequired

paginationRequestParamsobject(OffsetBasedPaginationRequestParams)required

Pagination parameters for requests.

includePnrSummariesboolean

Boolean flag to include PNR summaries in the response

Example:true

tripFiltersArray of objects(TripFilters)

Filter for the list trip summary request.

sortOptionsArray of objects(TripSortOptions)

Sort options for the list trip summary request

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v3/trips/arrangers/4974a66b-7493-4f41-908c-58ba81093947/list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "paginationRequestParams": {
      "offset": 0,
      "limit": 100
    },
    "includePnrSummaries": true,
    "tripFilters": [
      {
        "filterType": "TRIP_USER_ID_FILTER",
        "userIds": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          }
        ]
      }
    ],
    "sortOptions": [
      {
        "sortField": "START_DATE",
        "sortOrder": "DESC"
      }
    ]
  }'

Responses

OK

Bodyapplication/json

paginationResponseParamsobject(PaginationResponseParams)required

Pagination parameters for response.

tripSummariesArray of objects(TripSummary)

List of Trip summaries

failedTripSummariesArray of objects(TripSummary)

List of Trip summaries

Response

{
  "paginationResponseParams": {
    "totalNumResults": 0
  },
  "tripSummaries": [
    { … }
  ],
  "failedTripSummaries": [
    { … }
  ]
}