Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Fetch user registrations for classes/workshops

Purpose: Use this API to fetch the user registrations to the classes or workshops.

You must specify the guest_id and the parameters mentioned in PATH PARAMS section.

get/v1/guests/{guest_id}/registrations?start_date=2022-10-15&end_date=2022-10-18&class_type=1&filters.period=0&page=2&size=2&expand[0]=centers&expand[1]=instructors&expand[2]=sessions&expand[3]=classes

Path parameters

guest_idstring required

Unique identifier of the guest.

start_datestring date required

Date from which the API must fetch the registrations.

end_datestring required

Date till which the API must fetch the user registrations.

class_typeinteger required

Type of the class in the registration. 1: Class, 3: Workshop

pageinteger required

The page number that is to be viewed.

sizeinteger required

Number of records page page. Max records is 100. Default is 10.

Query parameters

filtersstring

Filters applied on the response. Filter values - Past, Upcoming, All. Default value is All.

expandstring[]

optional parameter for the API response. The supporting values are centers/instructors/sessions/classes.

SortType'-1' | '0' | '1'

NotSpecified = -1,Ascending=0,Descending=1

Response

200

OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "registrations": [
    {
      "id": 71662,
      "guid": "5cc01170-0181-40e4-b590-159064e6ea3e",
      "session_id": "398233ac-0bfa-49ed-8a21-9e5286aadb5b",
      "instructor_id": "162472bd-bd27-480c-9b80-c7cbdff76bd8",
      "class_id": 20052,
      "center_id": "9a895b3c-1994-42c0-bc61-efda4a6e2828",
      "invoice_id": "aba81470-0b2f-4980-a62e-cb22b73dd0a1",
      "appointment_group_id": "1d525e9c-a1c1-417a-bfc8-52877449c168",
      "payment_source": "Dummy membership",
      "custom_form_fill_status": -1,
      "guest_form_status": "2"
    }
  ],
  "page_info": {
    "total": 1,
    "page": 1,
    "size": 10
  }
}