Get All Carpool Booking Purposes
GET/carpool/booking-purposes
Retrieve the paginated list of active booking purposes configured under the authenticated client. Use booking_purpose_id as the booking_purpose_id of POST /carpool/bookings.
Request
Responses
- 200
- 401
- 403
- 422
- 429
- 500
- 503
A paginated list of active carpool booking purposes.
Unauthorized access. Authentication is required.
Access is forbidden. The user does not have permission to access this resource, or the account is not currently active.
Validation failed for the input parameters.
Too Many Requests - the endpoint's rate limit has been exceeded. Retry after the number of seconds in the Retry-After header.
Response Headers
Seconds to wait before retrying. The same value as X-RateLimit-Retry-After-Seconds when that wait is non-negative. If the computed wait is negative, Retry-After is floored at 0.
Unix timestamp of the next earliest successful request.
Seconds until the next earliest successful request.
Internal server error.
Service temporarily unavailable. The request did not complete and can be retried after the number of seconds in the Retry-After header, when one is sent.
Response Headers
Seconds to wait before retrying. Sent with db_busy and db_pool_timeout.