Retrieve the session registrations of a center

GET https://api.zenoti.com/Appointments/Sessions/40747

This API helps you to retrieve the list of class session registrations in the specified center.

You must provide the appropriate details in the API request for the session_id parameter. Optionally, you can also specify the required details in the API request for the StatusString parameter to filter the search results by registration status in the API response. Refer to the Request Parameters table for more information.

Before you begin

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

Endpoint

GET /Appointments/Sessions/40747

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

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Query parameters

Parameter Type Required Default Description
session_id integer (int64) Yes — Mandatory Unique identifier of the class session registration.
StatusString enum () No — Optional Filters the search results by registration status in the API response. This parameter accepts multiple values separated by commas. Registered = 0, Cancelled = 1, NoShow = 2, SignedIn = 3, Waitlisted = 4, Substituted = 5, ClassCancelled = 6, Closed = 7, Enrolled = 8, and Rejected = 9.

Response

Success (200 OK)

{
  "results": [
    {
      "...": "..."
    }
  ],
  "Error": {}
}

Response fields

Field Type Description
results object[]
results[].UserId string
results[].SessionFK integer
results[].SessionId integer
results[].RegistrationPK integer
results[].RegistrationId integer
results[].indicators string
results[].Name string
results[].LogData string
results[].Email string
results[].Mobile string
results[].PaymentType string
results[].PaymentSource string
results[].BalanceBalance integer
results[].BookedFrom string
results[].IsFree boolean
results[].IsFromWaitlist boolean
results[].status integer
results[].invoiceId string
results[].AppGroupId string
results[].registrationdt string
results[].notes object
results[].UserCode string
results[].RedemptionType object
results[].SortOrder integer
results[].LastUpdated string
Error object

Example

curl --request GET \
  --url 'https://api.zenoti.com/Appointments/Sessions/40747?session_id={{session_id}}' \
  --header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/Appointments/Sessions/40747', {
  method: 'GET',
  headers: {
    'Authorization': 'bearer {{access_token}}'
  },
});
const data = await response.json();
import requests

response = requests.get(
    'https://api.zenoti.com/Appointments/Sessions/40747',
    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/Appointments/Sessions/40747");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/Appointments/Sessions/40747')
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