v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB

Class Reservations

Get Lead Reservations

Returns a list of Class Reservations for a Lead.

get/leads/{lead_id}/classes/reservations

Path parameters

lead_idinteger required

Lead identifier.

Query parameters

sortstring

Specifies the order in which the Lead list will be returned. Default order is ascending. Default sort attribute is Id. Specify desc_ to sort descending format: "sort=desc_snake_cased_attribute_name" OR "sort=snake_cased_attribute_name" ex. sort=desc_updated_on

pageinteger

Specifies the page of records to be returned. Defaults to 1.

page_sizeinteger

Number of records to return per page. Maximum and default are 100 records.

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Web Integrations screen.

Response

Lead record list.

Example response

{
  "lead_class_reservations": [
    {
      "reservation_id": 1234567891234567,
      "lead_id": 1234567891234567,
      "class_id": 1234567891234567,
      "utc_class_start_datetime": "2014-12-31T23:59:59.938Z",
      "utc_class_end_datetime": "2014-12-31T23:59:59.938Z",
      "local_class_start_datetime": "2014-12-31T23:59:59.938Z",
      "local_class_end_datetime": "2014-12-31T23:59:59.938Z",
      "location_id": 1234567891234567,
      "coaches": [
        {
          "coach_id": 1234567891234567,
          "payroll_position_id": 1234567891234567
        }
      ],
      "reservation_status_id": 1234567891234567,
      "created": {
        "created_by_id": 1234567891234567,
        "created_on_datetime": "2014-12-31T23:59:59.938Z"
      },
      "updated": {
        "updated_by_id": 1234567891234567,
        "updated_on_datetime": "2014-12-31T23:59:59.938Z"
      },
      "membership_id": 1234567891234567
    }
  ]
}