Partner API
Reservations

List class reservations

Retrieve reservations for a specific class

get/{partnerId}/classes/{classId}/reservations

Request

  • Base URL: https://us-central1-sutra-prod.cloudfunctions.net/partnerApi/v0
  • URL: https://us-central1-sutra-prod.cloudfunctions.net/partnerApi/v0/{partnerId}/classes/{classId}/reservations
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

partnerIdstring required
Example:partner123

Partner identifier

classIdstring required
Example:class123

Class identifier

Query parameters

limitinteger
Example:10

Number of items to return (default 10, max 100)

start_afterstring
Example:item123

ID to start after for pagination

Response

Successful response

Example response

{
  "items": [
    {
      "id": "reservation123",
      "client_id": "client123",
      "class_id": "class123",
      "client": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "john@example.com",
        "phone": "+1234567890"
      },
      "status": "BOOKED",
      "created_at": "2024-03-20T12:00:00Z",
      "updated_at": "2024-03-20T12:00:00Z",
      "spot_id": "spot1",
      "spot_name": "Spot 1"
    }
  ],
  "pagination": {
    "limit": 10,
    "nextStartAfterId": "item123"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.