Fetch a list of booked users of a Workshop event

GET https://api.zenoti.com/v1/workshops/{workshop_id}/registrations

Purpose: Use this API to fetch a list of all the booked users of a particular workshop event.

You must specify workshop_id with center_id and session_id as query params.

Before you begin

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

Endpoint

GET /v1/workshops/{workshop_id}/registrations

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

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Path parameters

Parameter Type Required Description
workshop_id integer (int64) Yes Unique identifier of the workshop event.

Query parameters

Parameter Type Required Default Description
center_id string Yes — Unique identifier of the center.
session_id string Yes — Unique identifier of the session.
expand string No — (optional) Specify the value of this parameter as session or status_count and the API response will return those details.
page integer (int32) No 1 (optional) Number of display details. Pagination information
size integer (int32) No — optional parameter

Response

Success (200 OK)

{}

Example

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

response = requests.get(
    'https://api.zenoti.com/v1/workshops/{workshop_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/workshops/{workshop_id}/registrations");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/workshops/{workshop_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