List organization custom fields
Retrieves all custom fields configured at the organization level for guests, employees, or appointments.
Before you begin
- You need a valid API key or access token. See Set up API authentication.
Permission: Manage API Keys (under Administrator) — Required to access Zenoti APIs.
Endpoint
GET /v1/organizations/custom_fields
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| entity_type | string | No | — | guest, employee, or appointment |
Response
Success (200 OK)
{
"custom_fields": [
{
"id": "cf1a2b3c-d4e5-6f78-9012-abcdef345678",
"name": "Preferred Language",
"field_type": "dropdown",
"entity_type": "guest",
"options": ["English", "Spanish", "French"],
"is_required": false
}
],
"error": null
}
Response fields
| Field | Type | Description |
|---|---|---|
| custom_fields | array | List of custom field definitions |
| custom_fields[].id | string (GUID) | Custom field identifier |
| custom_fields[].field_type | string | text, number, dropdown, date, checkbox |
| custom_fields[].entity_type | string | Entity this field applies to |
| custom_fields[].options | array | Dropdown options (if applicable) |
Example
curl --request GET \
--url 'https://api.zenoti.com/v1/organizations/custom_fields?entity_type=guest' \
--header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/organizations/custom_fields', {
method: 'GET',
headers: {
'Authorization': 'bearer {{access_token}}'
},
});
const data = await response.json();
import requests
response = requests.get(
'https://api.zenoti.com/v1/organizations/custom_fields',
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/organizations/custom_fields");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/organizations/custom_fields')
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)
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.zenoti.com/v1/organizations/custom_fields');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: bearer {{access_token}}'
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
Error codes
| Status | Description |
|---|---|
| 401 | Unauthorized — invalid or expired access token |
| 429 | Too many requests — rate limit exceeded (60/min) |