Get guest consent for ZenScribe
This API fetches guest consent.
Before you begin
- You need a valid API key or access token. See Set up API authentication.
Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.
Endpoint
GET /v1/zenscribe/consents
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| owner_id | integer (int32) | No | — | The unique ID of the owner |
| owner_type | integer (int32) | No | — | The unique owner type assigned to the owner ID |
Response
Success (200 OK)
{
"consent": {
"guest_name": "Hari Rest",
"signature": "test",
"created_date": "2025-07-18T13:25:37.347",
"created_by_name": "dev owner"
},
"error": {}
}
Response fields
| Field | Type | Description |
|---|---|---|
| consent | object | |
| consent.guest_name | string | |
| consent.signature | string | |
| consent.created_date | string | |
| consent.created_by_name | string | |
| error | object |
Example
curl --request GET \
--url 'https://api.zenoti.com/v1/zenscribe/consents' \
--header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/zenscribe/consents', {
method: 'GET',
headers: {
'Authorization': 'bearer {{access_token}}'
},
});
const data = await response.json();
import requests
response = requests.get(
'https://api.zenoti.com/v1/zenscribe/consents',
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/zenscribe/consents");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/zenscribe/consents')
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 |
| 403 | 403 |
| 429 | Too many requests -- rate limit exceeded |