Retrieve Class Registrations

GET https://api.zenoti.com/v1/classes/{class_id}/registrations

This API helps you to retrieve a list of registrations for the class sessions.

You must provide the appropriate details in the API request for the class_id, session_id and center_id parameters. Optionally, you can also specify the required expand parameters in the API request. Refer to the Request Parameters table for more information.


On this page


Before you begin

Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.

Endpoint

GET /v1/classes/{class_id}/registrations

Base URL: https://api.zenoti.com

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Path parameters

Parameter Type Required Description
class_id string Yes Unique identifier of a class.

Query parameters

Parameter Type Required Default Description
Session_id string Yes — Mandatory Unique session id for which the registrations are to be returned.
Center_id string Yes — Mandatory Unique 32 character identifier of the center for the session.
Class_id integer (int32) Yes — Mandatory Unique identifier of the class.
expand string No — Optional Populates the 'session' objects.
expand string No — Optional Populates the 'status_count' objects.
page integer (int32) No 1 Optional Number of display page for the records. Default value is 1.
size integer (int32) No 10 Optional Number of records displayed per page. Default value is 10.

Response

Success (200 OK)

{
  "registrations": [
    {
      "...": "..."
    }
  ],
  "session": {
    "id": 91350,
    "name": "VB_Zoom-18May",
    "code": {},
    "start_time": "2021-06-25T00:00:00",
    "end_time": "2021-06-25T00:30:00",
    "start_time_utc": "0001-01-01T00:00:00",
    "end_time_utc": "0001-01-01T00:00:00",
    "duration": 30,
    "center_id": "d51712b1-6040-4dd4-abff-cffc9d36f89e",
    "class_id": 11232,
    "instructor_id": "b4ae773a-f805-440f-b968-0f49c014fb02",
    "room_id": "2310a3f6-3769-401c-8162-71f76baa2e26",
    "status_id": 0,
    "recurrence_id": 32008,
    "catalog_name": {},
    "catalog_price": "9000",
    "show_in_catalog": 1,
    "capacity": 10,
    "web_capacity": 5,
    "occupancy": 1,
    "web_occupancy": 1,
    "available_slots": 9,
    "waitlisted_count": 0,
    "is_open_for_registration": true,
    "is_cancelled": false,
    "is_free_session": false,
    "description": {},
    "description_html": {},
    "track_ids": {},
    "service_id": "97e3f904-d94b-417a-b533-5b4a4ddc7b69",
    "active_request_id": {},
    "cancellation_fee_window": {},
    "cancellation_fee": {},
    "allow_cancellation_fee": false,
    "student_virtual_link": {},
    "instructor_virtual_link": {},
    "virtual_type": 0,
    "is_instructor_substituted": false
  },
  "status_count": [
    {
      "...": "..."
    }
  ],
  "occupancy": 1,
  "page_details": {
    "total": 37,
    "page": -1,
    "size": 10
  },
  "error": {}
}

Response fields

Field Type Description
registrations object[]
registrations[].id integer
registrations[].delete_status string
registrations[].guest object
registrations[].session_id integer
registrations[].indicators string
registrations[].log_data string
registrations[].payment_type string
registrations[].payment_source string
registrations[].booked_from string
registrations[].registration_source string
registrations[].is_free integer
registrations[].is_from_waitlist boolean
registrations[].status integer
registrations[].pre_close_status object
registrations[].is_any_session_noshow boolean
registrations[].invoice_id string
registrations[].appointment_group_id string
registrations[].appointment_ids object
registrations[].registration_dt string
registrations[].notes string
registrations[].user_code string
registrations[].redemption_type string
registrations[].sort_order integer
registrations[].last_updated string
registrations[].balance integer
registrations[].feedback_status integer
session object
session.id integer
session.name string
session.code object
session.start_time string
session.end_time string
session.start_time_utc string
session.end_time_utc string
session.duration integer
session.center_id string
session.class_id integer
session.instructor_id string
session.room_id string
session.status_id integer
session.recurrence_id integer
session.catalog_name object
session.catalog_price string
session.show_in_catalog integer
session.capacity integer
session.web_capacity integer
session.occupancy integer
session.web_occupancy integer
session.available_slots integer
session.waitlisted_count integer
session.is_open_for_registration boolean
session.is_cancelled boolean
session.is_free_session boolean
session.description object
session.description_html object
session.track_ids object
session.service_id string
session.active_request_id object
session.cancellation_fee_window object
session.cancellation_fee object
session.allow_cancellation_fee boolean
session.student_virtual_link object
session.instructor_virtual_link object
session.virtual_type integer
session.is_instructor_substituted boolean
status_count object[]
status_count[].registered integer
status_count[].waitlisted integer
status_count[].total integer
status_count[].closed integer
status_count[].signed_in integer
status_count[].canceled integer
status_count[].no_show integer
status_count[].open integer
status_count[].enrolled integer
status_count[].rejected integer
status_count[].web integer
status_count[].store integer
status_count[].occupancy integer
occupancy integer
page_details object
page_details.total integer
page_details.page integer
page_details.size integer
error object

Example

curl --request GET \
  --url 'https://api.zenoti.com/v1/classes/{class_id}/registrations?Session_id={{Session_id}}&Center_id={{Center_id}}&Class_id={{Class_id}}' \
  --header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/classes/{class_id}/registrations', {
  method: 'GET',
  headers: {
    'Authorization': 'bearer {{access_token}}'
  },
});
const data = await response.json();
import requests

response = requests.get(
    'https://api.zenoti.com/v1/classes/{class_id}/registrations',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.GetAsync(
    "https://api.zenoti.com/v1/classes/{class_id}/registrations");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/classes/{class_id}/registrations')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
response = http.request(request)
data = JSON.parse(response.body)

Error codes

Status Description
400 400
401 Unauthorized -- invalid or expired access token
429 Too many requests -- rate limit exceeded