Calendars
Reusable booking pages (Calendly-style). Each calendar has a public URL slug, a weekly availability schedule, intake fields, and confirmation/reminder messaging. The hosted booking link is returned as booking_url.
For a single scheduled meeting, see Appointments.
Sorted newest-created first (_id descending) - a small limit returns the most recently created calendars, not necessarily every calendar on the account.
By default only non-inactive calendars are returned (status missing/null/empty is treated as active, same as an unset status field). Pass filter[status]=inactive for only inactive ones, or filter[status]=all to remove the status restriction entirely.
The API Secret from the Gleantap dashboard under Settings β API (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as gltp_sk_live_<40-hex>. There is no sandbox: every key acts on the live account.
Keys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default β narrow with ?workroom= / Gleantap-Workroom on each request. Revoke via the dashboard.
For per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.
Same semantics as the Gleantap-Workroom header, including that a write should never be sent without a workroom the user actually chose, and that an omitted workroom scopes a read to the account default rather than spanning the account. Prefer this on GETs so proxies and caches can key on it. Accepts name, prefixed ID, raw hex, or all.
Page size. Default 25, max 100.
25Opaque cursor from a prior response's next_cursor, to fetch the NEXT page (alias - after). On listContacts and listSegmentContacts, use before with a prev_cursor to page backward; other list endpoints are forward-only.
Minor version to run the request under (date-based). Older dates remain supported for at least 24 months. If omitted, the account's default pinned version is used.
2026-05-27Pattern: ^\d{4}-\d{2}-\d{2}$Target customer account, as acc_<24-hex> or a bare 24-hex ID. Only for Gleantap staff (CSM) tokens, which authenticate against the internal staff directory and are bound to no account; for a normal customer token the account is fixed by the token and this header is ignored.
A staff token MUST name an account on every request β there is no default, and omitting it returns 400 admin_account_required rather than falling back to some first account. Switching accounts is just a different value here; no re-authorization. Account names are rejected (400 admin_account_invalid) because they are neither unique nor stable β list IDs with GET /v3/accounts.
Every impersonated response carries an impersonation block naming the account actually acted on, so an account switch mid-session is always visible. Also settable via ?account=.
acc_59fca1e3d2a57d28a10b0442Which workroom to act in. Accepts a workroom name (case-insensitive), a prefixed ID (wrm_<hex>), a raw 24-hex ID, or the literal all.
On any write, ask the user which workroom β do not omit this. Optional here means the server has a fallback, not that the fallback is what anyone wanted: an omitted workroom sends the write to the account's default workroom, and accounts routinely have dozens. Creating a contact, flow, campaign or segment in the wrong workroom puts it where nobody is looking, and moving it afterwards is manual.
The one case where you need not ask: the account has exactly one workroom. Call listWorkrooms to find out β if it returns a single row, use it; if it returns several, ask which one before writing.
Reads are scoped too. Omitting a workroom on a read does not span the account β it narrows to the same default workroom a write would go to, and the response carries a workroom_defaulted warning saying so. So a count, a list or a segment preview describes one workroom unless you said otherwise. Pass all to deliberately span every workroom; that is the only way to get account-wide figures, and it is never the default. listWorkrooms itself is never narrowed, since it is how you discover what to ask for.
Also settable via ?workroom= or a workroom body field (POST/PATCH only) β query wins over header wins over body.
G Test1Page of calendars.
True if additional records exist beyond this page.
Opaque cursor for the next page. Null on the last page.
Cursor for the previous page. Supported on listContacts and listSegmentContacts: pass it back as ?before=... to page backward; null on the first page. On every other list endpoint paging is forward-only and this is always null.
GET /v3/calendars HTTP/1.1
Host: api.gleantap.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Page of calendars.
{
"object": "text",
"data": [
{
"object": "text",
"id": "cal_66d9a11d0e5b7c1a4d8e2f1e",
"workroom_id": "wrm_5ace370fd2a57d74d0548fb2",
"name": "text",
"slug": "text",
"meeting_type": "meeting",
"status": "active",
"booking_url": "text",
"assigned_user_ids": [
"text"
],
"duration_minutes": 1,
"buffer_minutes": 1,
"minimum_booking_window": 1,
"appointment_type_id": "text",
"notify_type": "roundrobin",
"instructions": "text",
"address": "text",
"submit_button_text": "text",
"custom_redirect_url": "text",
"default_capture": [
"name"
],
"custom_questions": [
{
"label": "text",
"type": "text",
"required": false,
"options": [
"text"
]
}
],
"schedule": {
"monday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"tuesday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"wednesday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"thursday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"friday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"saturday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"sunday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
]
},
"confirmation": {
"type": [
"sms"
],
"email_subject": "text",
"message": "text",
"email": "text"
},
"reminders": [
{
"type": "sms",
"subject": "text",
"due_hour": "text",
"message": "text",
"email": "text"
}
],
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}
],
"has_more": true,
"next_cursor": "text",
"prev_cursor": "text"
}Create a bookable calendar - this IS what "calendar meeting," "calendar invite," or "create a calendar" mean. Not a single scheduled meeting (that's createAppointment).
meeting_type: meeting for workroom-wide meetings; meeting_type: user for per-staff calendars - this kind must have exactly one owner, defaulted to the calling user when the caller is human, otherwise assigned_user_ids must be passed explicitly (an API-key caller has no calling user to default to).
Slugs are auto-generated from name if not supplied and are unique per workroom; conflicts get numeric suffixes automatically.
A bookable calendar is defined by six things, and a calendar missing any of them is created successfully but does not work as intended:
workroom β an omitted workroom resolves to the account default.
listWorkroomsreturns the alternatives.name
appointment type β
listAppointmentTypes, scoped to the target workroom, returns the types that already exist. A new name creates a new type.assigned_user_idsβ who the bookings belong to. Formeeting_type: meetingthe candidates come fromlistStaff; formeeting_type: userthis defaults to the calling user.duration_minutesβ the length of each booking, e.g. 15/30/45/60. Required: without it the dashboard cannot generate bookable time slots at all.availability β which days and hours are offered.
capture fields β any of
name,email,phone,dob, plus custom questions. Email or phone is required; a request with neither is rejected.
Optional fields fall back to a server-side default when omitted. Defaults are not inferred from the account's other calendars, so settings that match an existing pattern elsewhere still have to be passed explicitly.
The API Secret from the Gleantap dashboard under Settings β API (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as gltp_sk_live_<40-hex>. There is no sandbox: every key acts on the live account.
Keys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default β narrow with ?workroom= / Gleantap-Workroom on each request. Revoke via the dashboard.
For per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.
Same semantics as the Gleantap-Workroom header, including that a write should never be sent without a workroom the user actually chose, and that an omitted workroom scopes a read to the account default rather than spanning the account. Prefer this on GETs so proxies and caches can key on it. Accepts name, prefixed ID, raw hex, or all.
Minor version to run the request under (date-based). Older dates remain supported for at least 24 months. If omitted, the account's default pinned version is used.
2026-05-27Pattern: ^\d{4}-\d{2}-\d{2}$Target customer account, as acc_<24-hex> or a bare 24-hex ID. Only for Gleantap staff (CSM) tokens, which authenticate against the internal staff directory and are bound to no account; for a normal customer token the account is fixed by the token and this header is ignored.
A staff token MUST name an account on every request β there is no default, and omitting it returns 400 admin_account_required rather than falling back to some first account. Switching accounts is just a different value here; no re-authorization. Account names are rejected (400 admin_account_invalid) because they are neither unique nor stable β list IDs with GET /v3/accounts.
Every impersonated response carries an impersonation block naming the account actually acted on, so an account switch mid-session is always visible. Also settable via ?account=.
acc_59fca1e3d2a57d28a10b0442Which workroom to act in. Accepts a workroom name (case-insensitive), a prefixed ID (wrm_<hex>), a raw 24-hex ID, or the literal all.
On any write, ask the user which workroom β do not omit this. Optional here means the server has a fallback, not that the fallback is what anyone wanted: an omitted workroom sends the write to the account's default workroom, and accounts routinely have dozens. Creating a contact, flow, campaign or segment in the wrong workroom puts it where nobody is looking, and moving it afterwards is manual.
The one case where you need not ask: the account has exactly one workroom. Call listWorkrooms to find out β if it returns a single row, use it; if it returns several, ask which one before writing.
Reads are scoped too. Omitting a workroom on a read does not span the account β it narrows to the same default workroom a write would go to, and the response carries a workroom_defaulted warning saying so. So a count, a list or a segment preview describes one workroom unless you said otherwise. Pass all to deliberately span every workroom; that is the only way to get account-wide figures, and it is never the default. listWorkrooms itself is never narrowed, since it is how you discover what to ask for.
Also settable via ?workroom= or a workroom body field (POST/PATCH only) β query wins over header wins over body.
G Test1A unique key (β€255 chars) chosen by the client. Replays with the same key + same body return the cached response. Replays with the same key + different body return 409 idempotency_conflict. Required on messaging sends and bulk operations; recommended elsewhere.
8e3c7a90-7c4d-4f8e-8e3c-7a907c4d4f8ewrm_5ace370fd2a57d74d0548fb2Pattern: ^wrm_[0-9a-f]{24}$Whether this is a general workroom-wide calendar (meeting) or a personal per-staff calendar (user). Not related to how bookings are assigned across staff - see notify_type. "user" must have exactly one owner: defaults to the calling user for a human caller, otherwise assigned_user_ids is required.
meetingPossible values: activePossible values: Each id must be an existing staff member in this account - an id that is well-formed but doesn't exist returns a not-found error rather than being silently accepted.
Required. Length of each booking. Without this the dashboard cannot generate bookable time slots for this calendar.
Buffer between back-to-back bookings. Cannot be negative.
Minimum hours ahead a booking can be made. Cannot be negative.
Required. The appointment type this calendar books, by id (atyp_...) or by name. An id that is well-formed but doesn't exist in this workroom returns a not-found error - it is never treated as a name. Matching by name is exact and silent: any name that does not match an existing type exactly - including a typo or near-miss - creates a brand new appointment type with no error, which can quietly fill the workroom with unwanted types. List GET /v3/appointment_types first and confirm the exact name (or that a new one is really wanted) with the user instead of guessing.
How bookings are assigned across assigned_user_ids: one at a time (roundrobin) or all of them (all). This is what the Gleantap dashboard UI itself labels "Meeting Type" - do not confuse with the meeting_type field above.
roundrobinPossible values: Where a booker is sent right after booking. Must be a valid http:// or https:// URL, or blank to clear a previously-set redirect.
Calendar created.
Bookable calendar ID.
cal_66d9a11d0e5b7c1a4d8e2f1ePattern: ^cal_[0-9a-fA-F]{24}$wrm_5ace370fd2a57d74d0548fb2Pattern: ^wrm_[0-9a-f]{24}$Public URL segment. Unique per workroom.
Whether this is a general workroom-wide calendar (meeting) or a personal per-staff calendar (user). Not related to how bookings are assigned across staff - see notify_type.
Public dashboard-hosted booking page. Hand this URL to end users.
Each id must be an existing staff member in this account - an id that is well-formed but doesn't exist returns a not-found error rather than being silently accepted.
Buffer between back-to-back bookings. Cannot be negative.
Minimum hours ahead a booking can be made. Cannot be negative.
The appointment type this calendar books, by id (atyp_...) or by name. An id that is well-formed but doesn't exist in this workroom returns a not-found error - it is never treated as a name. Matching by name is exact and silent: any name that does not match an existing type exactly - including a typo or near-miss - creates a brand new appointment type with no error, which can quietly fill the workroom with unwanted types. List GET /v3/appointment_types first and confirm the exact name (or that a new one is really wanted) with the user instead of guessing.
How bookings are assigned across assigned_user_ids: one at a time (roundrobin) or all of them (all). This is what the Gleantap dashboard UI itself labels "Meeting Type" - do not confuse with the meeting_type field above.
Where a booker is sent right after booking.
Semantic validation failed β the request is well-formed but references an object in the wrong state (e.g., sending to an opted-out contact).
POST /v3/calendars HTTP/1.1
Host: api.gleantap.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1041
{
"name": "text",
"slug": "text",
"workroom_id": "wrm_5ace370fd2a57d74d0548fb2",
"meeting_type": "meeting",
"status": "active",
"assigned_user_ids": [
"text"
],
"duration_minutes": 1,
"buffer_minutes": 1,
"minimum_booking_window": 1,
"appointment_type_id": "text",
"notify_type": "roundrobin",
"instructions": "text",
"address": "text",
"submit_button_text": "text",
"custom_redirect_url": "text",
"default_capture": [
"name"
],
"custom_questions": [
{
"label": "text",
"type": "text",
"required": false,
"options": [
"text"
]
}
],
"schedule": {
"monday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"tuesday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"wednesday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"thursday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"friday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"saturday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"sunday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
]
},
"confirmation": {
"type": [
"sms"
],
"email_subject": "text",
"message": "text",
"email": "text"
},
"reminders": [
{
"type": "sms",
"subject": "text",
"due_hour": "text",
"message": "text",
"email": "text"
}
]
}{
"object": "text",
"id": "cal_66d9a11d0e5b7c1a4d8e2f1e",
"workroom_id": "wrm_5ace370fd2a57d74d0548fb2",
"name": "text",
"slug": "text",
"meeting_type": "meeting",
"status": "active",
"booking_url": "text",
"assigned_user_ids": [
"text"
],
"duration_minutes": 1,
"buffer_minutes": 1,
"minimum_booking_window": 1,
"appointment_type_id": "text",
"notify_type": "roundrobin",
"instructions": "text",
"address": "text",
"submit_button_text": "text",
"custom_redirect_url": "text",
"default_capture": [
"name"
],
"custom_questions": [
{
"label": "text",
"type": "text",
"required": false,
"options": [
"text"
]
}
],
"schedule": {
"monday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"tuesday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"wednesday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"thursday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"friday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"saturday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"sunday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
]
},
"confirmation": {
"type": [
"sms"
],
"email_subject": "text",
"message": "text",
"email": "text"
},
"reminders": [
{
"type": "sms",
"subject": "text",
"due_hour": "text",
"message": "text",
"email": "text"
}
],
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}The API Secret from the Gleantap dashboard under Settings β API (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as gltp_sk_live_<40-hex>. There is no sandbox: every key acts on the live account.
Keys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default β narrow with ?workroom= / Gleantap-Workroom on each request. Revoke via the dashboard.
For per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.
Bookable calendar ID.
cal_66d9a11d0e5b7c1a4d8e2f1ePattern: ^cal_[0-9a-fA-F]{24}$Same semantics as the Gleantap-Workroom header, including that a write should never be sent without a workroom the user actually chose, and that an omitted workroom scopes a read to the account default rather than spanning the account. Prefer this on GETs so proxies and caches can key on it. Accepts name, prefixed ID, raw hex, or all.
Minor version to run the request under (date-based). Older dates remain supported for at least 24 months. If omitted, the account's default pinned version is used.
2026-05-27Pattern: ^\d{4}-\d{2}-\d{2}$Target customer account, as acc_<24-hex> or a bare 24-hex ID. Only for Gleantap staff (CSM) tokens, which authenticate against the internal staff directory and are bound to no account; for a normal customer token the account is fixed by the token and this header is ignored.
A staff token MUST name an account on every request β there is no default, and omitting it returns 400 admin_account_required rather than falling back to some first account. Switching accounts is just a different value here; no re-authorization. Account names are rejected (400 admin_account_invalid) because they are neither unique nor stable β list IDs with GET /v3/accounts.
Every impersonated response carries an impersonation block naming the account actually acted on, so an account switch mid-session is always visible. Also settable via ?account=.
acc_59fca1e3d2a57d28a10b0442Which workroom to act in. Accepts a workroom name (case-insensitive), a prefixed ID (wrm_<hex>), a raw 24-hex ID, or the literal all.
On any write, ask the user which workroom β do not omit this. Optional here means the server has a fallback, not that the fallback is what anyone wanted: an omitted workroom sends the write to the account's default workroom, and accounts routinely have dozens. Creating a contact, flow, campaign or segment in the wrong workroom puts it where nobody is looking, and moving it afterwards is manual.
The one case where you need not ask: the account has exactly one workroom. Call listWorkrooms to find out β if it returns a single row, use it; if it returns several, ask which one before writing.
Reads are scoped too. Omitting a workroom on a read does not span the account β it narrows to the same default workroom a write would go to, and the response carries a workroom_defaulted warning saying so. So a count, a list or a segment preview describes one workroom unless you said otherwise. Pass all to deliberately span every workroom; that is the only way to get account-wide figures, and it is never the default. listWorkrooms itself is never narrowed, since it is how you discover what to ask for.
Also settable via ?workroom= or a workroom body field (POST/PATCH only) β query wins over header wins over body.
G Test1Calendar.
Bookable calendar ID.
cal_66d9a11d0e5b7c1a4d8e2f1ePattern: ^cal_[0-9a-fA-F]{24}$wrm_5ace370fd2a57d74d0548fb2Pattern: ^wrm_[0-9a-f]{24}$Public URL segment. Unique per workroom.
Whether this is a general workroom-wide calendar (meeting) or a personal per-staff calendar (user). Not related to how bookings are assigned across staff - see notify_type.
Public dashboard-hosted booking page. Hand this URL to end users.
Each id must be an existing staff member in this account - an id that is well-formed but doesn't exist returns a not-found error rather than being silently accepted.
Buffer between back-to-back bookings. Cannot be negative.
Minimum hours ahead a booking can be made. Cannot be negative.
The appointment type this calendar books, by id (atyp_...) or by name. An id that is well-formed but doesn't exist in this workroom returns a not-found error - it is never treated as a name. Matching by name is exact and silent: any name that does not match an existing type exactly - including a typo or near-miss - creates a brand new appointment type with no error, which can quietly fill the workroom with unwanted types. List GET /v3/appointment_types first and confirm the exact name (or that a new one is really wanted) with the user instead of guessing.
How bookings are assigned across assigned_user_ids: one at a time (roundrobin) or all of them (all). This is what the Gleantap dashboard UI itself labels "Meeting Type" - do not confuse with the meeting_type field above.
Where a booker is sent right after booking.
The resource doesn't exist or isn't visible to this caller.
GET /v3/calendars/{id} HTTP/1.1
Host: api.gleantap.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"object": "text",
"id": "cal_66d9a11d0e5b7c1a4d8e2f1e",
"workroom_id": "wrm_5ace370fd2a57d74d0548fb2",
"name": "text",
"slug": "text",
"meeting_type": "meeting",
"status": "active",
"booking_url": "text",
"assigned_user_ids": [
"text"
],
"duration_minutes": 1,
"buffer_minutes": 1,
"minimum_booking_window": 1,
"appointment_type_id": "text",
"notify_type": "roundrobin",
"instructions": "text",
"address": "text",
"submit_button_text": "text",
"custom_redirect_url": "text",
"default_capture": [
"name"
],
"custom_questions": [
{
"label": "text",
"type": "text",
"required": false,
"options": [
"text"
]
}
],
"schedule": {
"monday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"tuesday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"wednesday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"thursday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"friday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"saturday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"sunday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
]
},
"confirmation": {
"type": [
"sms"
],
"email_subject": "text",
"message": "text",
"email": "text"
},
"reminders": [
{
"type": "sms",
"subject": "text",
"due_hour": "text",
"message": "text",
"email": "text"
}
],
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}Change a booking calendar β its name, URL slug, weekly availability, the details it captures from bookers, or its confirmation and reminder messaging. Only the fields supplied are changed. Changing the slug changes the public booking URL, so links already shared stop resolving.
The API Secret from the Gleantap dashboard under Settings β API (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as gltp_sk_live_<40-hex>. There is no sandbox: every key acts on the live account.
Keys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default β narrow with ?workroom= / Gleantap-Workroom on each request. Revoke via the dashboard.
For per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.
Bookable calendar ID.
cal_66d9a11d0e5b7c1a4d8e2f1ePattern: ^cal_[0-9a-fA-F]{24}$Same semantics as the Gleantap-Workroom header, including that a write should never be sent without a workroom the user actually chose, and that an omitted workroom scopes a read to the account default rather than spanning the account. Prefer this on GETs so proxies and caches can key on it. Accepts name, prefixed ID, raw hex, or all.
Minor version to run the request under (date-based). Older dates remain supported for at least 24 months. If omitted, the account's default pinned version is used.
2026-05-27Pattern: ^\d{4}-\d{2}-\d{2}$Target customer account, as acc_<24-hex> or a bare 24-hex ID. Only for Gleantap staff (CSM) tokens, which authenticate against the internal staff directory and are bound to no account; for a normal customer token the account is fixed by the token and this header is ignored.
A staff token MUST name an account on every request β there is no default, and omitting it returns 400 admin_account_required rather than falling back to some first account. Switching accounts is just a different value here; no re-authorization. Account names are rejected (400 admin_account_invalid) because they are neither unique nor stable β list IDs with GET /v3/accounts.
Every impersonated response carries an impersonation block naming the account actually acted on, so an account switch mid-session is always visible. Also settable via ?account=.
acc_59fca1e3d2a57d28a10b0442Which workroom to act in. Accepts a workroom name (case-insensitive), a prefixed ID (wrm_<hex>), a raw 24-hex ID, or the literal all.
On any write, ask the user which workroom β do not omit this. Optional here means the server has a fallback, not that the fallback is what anyone wanted: an omitted workroom sends the write to the account's default workroom, and accounts routinely have dozens. Creating a contact, flow, campaign or segment in the wrong workroom puts it where nobody is looking, and moving it afterwards is manual.
The one case where you need not ask: the account has exactly one workroom. Call listWorkrooms to find out β if it returns a single row, use it; if it returns several, ask which one before writing.
Reads are scoped too. Omitting a workroom on a read does not span the account β it narrows to the same default workroom a write would go to, and the response carries a workroom_defaulted warning saying so. So a count, a list or a segment preview describes one workroom unless you said otherwise. Pass all to deliberately span every workroom; that is the only way to get account-wide figures, and it is never the default. listWorkrooms itself is never narrowed, since it is how you discover what to ask for.
Also settable via ?workroom= or a workroom body field (POST/PATCH only) β query wins over header wins over body.
G Test1Partial update - every field is optional, only send what's changing. Deliberately a separate schema from CalendarCreate rather than reusing it: that one requires name, appointment_type_id, duration_minutes, schedule and default_capture, which would make a true partial update (e.g. just confirmation) look invalid even though the backend does not actually require any of them here.
Whether this is a general workroom-wide calendar (meeting) or a personal per-staff calendar (user). Not related to how bookings are assigned across staff - see notify_type. "user" must have exactly one owner - either already set, defaulted to the calling user for a human caller, or passed explicitly via assigned_user_ids.
Each id must be an existing staff member in this account - an id that is well-formed but doesn't exist returns a not-found error rather than being silently accepted.
Length of each booking.
Buffer between back-to-back bookings. Cannot be negative.
Minimum hours ahead a booking can be made. Cannot be negative.
The appointment type this calendar books, by id (atyp_...) or by name. An id that is well-formed but doesn't exist in this workroom returns a not-found error - it is never treated as a name. Matching by name is exact and silent: any name that does not match an existing type exactly - including a typo or near-miss - creates a brand new appointment type with no error, which can quietly fill the workroom with unwanted types. List GET /v3/appointment_types first and confirm the exact name (or that a new one is really wanted) with the user instead of guessing.
How bookings are assigned across assigned_user_ids: one at a time (roundrobin) or all of them (all). This is what the Gleantap dashboard UI itself labels "Meeting Type" - do not confuse with the meeting_type field above.
Where a booker is sent right after booking. Must be a valid http:// or https:// URL, or blank to clear a previously-set redirect.
Updated calendar.
Bookable calendar ID.
cal_66d9a11d0e5b7c1a4d8e2f1ePattern: ^cal_[0-9a-fA-F]{24}$wrm_5ace370fd2a57d74d0548fb2Pattern: ^wrm_[0-9a-f]{24}$Public URL segment. Unique per workroom.
Whether this is a general workroom-wide calendar (meeting) or a personal per-staff calendar (user). Not related to how bookings are assigned across staff - see notify_type.
Public dashboard-hosted booking page. Hand this URL to end users.
Each id must be an existing staff member in this account - an id that is well-formed but doesn't exist returns a not-found error rather than being silently accepted.
Buffer between back-to-back bookings. Cannot be negative.
Minimum hours ahead a booking can be made. Cannot be negative.
The appointment type this calendar books, by id (atyp_...) or by name. An id that is well-formed but doesn't exist in this workroom returns a not-found error - it is never treated as a name. Matching by name is exact and silent: any name that does not match an existing type exactly - including a typo or near-miss - creates a brand new appointment type with no error, which can quietly fill the workroom with unwanted types. List GET /v3/appointment_types first and confirm the exact name (or that a new one is really wanted) with the user instead of guessing.
How bookings are assigned across assigned_user_ids: one at a time (roundrobin) or all of them (all). This is what the Gleantap dashboard UI itself labels "Meeting Type" - do not confuse with the meeting_type field above.
Where a booker is sent right after booking.
The resource doesn't exist or isn't visible to this caller.
Semantic validation failed β the request is well-formed but references an object in the wrong state (e.g., sending to an opted-out contact).
PATCH /v3/calendars/{id} HTTP/1.1
Host: api.gleantap.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 996
{
"name": "text",
"slug": "text",
"meeting_type": "meeting",
"status": "active",
"assigned_user_ids": [
"text"
],
"duration_minutes": 1,
"buffer_minutes": 1,
"minimum_booking_window": 1,
"appointment_type_id": "text",
"notify_type": "roundrobin",
"instructions": "text",
"address": "text",
"submit_button_text": "text",
"custom_redirect_url": "text",
"default_capture": [
"name"
],
"custom_questions": [
{
"label": "text",
"type": "text",
"required": false,
"options": [
"text"
]
}
],
"schedule": {
"monday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"tuesday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"wednesday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"thursday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"friday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"saturday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"sunday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
]
},
"confirmation": {
"type": [
"sms"
],
"email_subject": "text",
"message": "text",
"email": "text"
},
"reminders": [
{
"type": "sms",
"subject": "text",
"due_hour": "text",
"message": "text",
"email": "text"
}
]
}{
"object": "text",
"id": "cal_66d9a11d0e5b7c1a4d8e2f1e",
"workroom_id": "wrm_5ace370fd2a57d74d0548fb2",
"name": "text",
"slug": "text",
"meeting_type": "meeting",
"status": "active",
"booking_url": "text",
"assigned_user_ids": [
"text"
],
"duration_minutes": 1,
"buffer_minutes": 1,
"minimum_booking_window": 1,
"appointment_type_id": "text",
"notify_type": "roundrobin",
"instructions": "text",
"address": "text",
"submit_button_text": "text",
"custom_redirect_url": "text",
"default_capture": [
"name"
],
"custom_questions": [
{
"label": "text",
"type": "text",
"required": false,
"options": [
"text"
]
}
],
"schedule": {
"monday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"tuesday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"wednesday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"thursday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"friday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"saturday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"sunday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
]
},
"confirmation": {
"type": [
"sms"
],
"email_subject": "text",
"message": "text",
"email": "text"
},
"reminders": [
{
"type": "sms",
"subject": "text",
"due_hour": "text",
"message": "text",
"email": "text"
}
],
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}Hard-deletes the calendar document, matching the dashboard's own delete exactly. Booking page returns 404.
Permanent. There is no undo and no trash to restore from. Confirm with the user before calling this - anything that references the deleted record is affected too.
The API Secret from the Gleantap dashboard under Settings β API (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as gltp_sk_live_<40-hex>. There is no sandbox: every key acts on the live account.
Keys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default β narrow with ?workroom= / Gleantap-Workroom on each request. Revoke via the dashboard.
For per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.
Bookable calendar ID.
cal_66d9a11d0e5b7c1a4d8e2f1ePattern: ^cal_[0-9a-fA-F]{24}$Same semantics as the Gleantap-Workroom header, including that a write should never be sent without a workroom the user actually chose, and that an omitted workroom scopes a read to the account default rather than spanning the account. Prefer this on GETs so proxies and caches can key on it. Accepts name, prefixed ID, raw hex, or all.
Minor version to run the request under (date-based). Older dates remain supported for at least 24 months. If omitted, the account's default pinned version is used.
2026-05-27Pattern: ^\d{4}-\d{2}-\d{2}$Target customer account, as acc_<24-hex> or a bare 24-hex ID. Only for Gleantap staff (CSM) tokens, which authenticate against the internal staff directory and are bound to no account; for a normal customer token the account is fixed by the token and this header is ignored.
A staff token MUST name an account on every request β there is no default, and omitting it returns 400 admin_account_required rather than falling back to some first account. Switching accounts is just a different value here; no re-authorization. Account names are rejected (400 admin_account_invalid) because they are neither unique nor stable β list IDs with GET /v3/accounts.
Every impersonated response carries an impersonation block naming the account actually acted on, so an account switch mid-session is always visible. Also settable via ?account=.
acc_59fca1e3d2a57d28a10b0442Which workroom to act in. Accepts a workroom name (case-insensitive), a prefixed ID (wrm_<hex>), a raw 24-hex ID, or the literal all.
On any write, ask the user which workroom β do not omit this. Optional here means the server has a fallback, not that the fallback is what anyone wanted: an omitted workroom sends the write to the account's default workroom, and accounts routinely have dozens. Creating a contact, flow, campaign or segment in the wrong workroom puts it where nobody is looking, and moving it afterwards is manual.
The one case where you need not ask: the account has exactly one workroom. Call listWorkrooms to find out β if it returns a single row, use it; if it returns several, ask which one before writing.
Reads are scoped too. Omitting a workroom on a read does not span the account β it narrows to the same default workroom a write would go to, and the response carries a workroom_defaulted warning saying so. So a count, a list or a segment preview describes one workroom unless you said otherwise. Pass all to deliberately span every workroom; that is the only way to get account-wide figures, and it is never the default. listWorkrooms itself is never narrowed, since it is how you discover what to ask for.
Also settable via ?workroom= or a workroom body field (POST/PATCH only) β query wins over header wins over body.
G Test1Deleted.
No content
The resource doesn't exist or isn't visible to this caller.
DELETE /v3/calendars/{id} HTTP/1.1
Host: api.gleantap.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Clones all settings β schedule, capture fields, confirmation, reminders β with a new slug. The clone starts status=inactive so callers can review and activate.
The API Secret from the Gleantap dashboard under Settings β API (Generate New Key if none exists). Send it bare (40 hex characters) or prefixed as gltp_sk_live_<40-hex>. There is no sandbox: every key acts on the live account.
Keys are account-scoped and carry all permissions on that account (no per-key scope selection). Cross-workroom reads are unrestricted by default β narrow with ?workroom= / Gleantap-Workroom on each request. Revoke via the dashboard.
For per-user consent, per-workroom scoping, and short-lived tokens, use OAuth 2.1 instead.
Bookable calendar ID.
cal_66d9a11d0e5b7c1a4d8e2f1ePattern: ^cal_[0-9a-fA-F]{24}$Same semantics as the Gleantap-Workroom header, including that a write should never be sent without a workroom the user actually chose, and that an omitted workroom scopes a read to the account default rather than spanning the account. Prefer this on GETs so proxies and caches can key on it. Accepts name, prefixed ID, raw hex, or all.
Minor version to run the request under (date-based). Older dates remain supported for at least 24 months. If omitted, the account's default pinned version is used.
2026-05-27Pattern: ^\d{4}-\d{2}-\d{2}$Target customer account, as acc_<24-hex> or a bare 24-hex ID. Only for Gleantap staff (CSM) tokens, which authenticate against the internal staff directory and are bound to no account; for a normal customer token the account is fixed by the token and this header is ignored.
A staff token MUST name an account on every request β there is no default, and omitting it returns 400 admin_account_required rather than falling back to some first account. Switching accounts is just a different value here; no re-authorization. Account names are rejected (400 admin_account_invalid) because they are neither unique nor stable β list IDs with GET /v3/accounts.
Every impersonated response carries an impersonation block naming the account actually acted on, so an account switch mid-session is always visible. Also settable via ?account=.
acc_59fca1e3d2a57d28a10b0442Which workroom to act in. Accepts a workroom name (case-insensitive), a prefixed ID (wrm_<hex>), a raw 24-hex ID, or the literal all.
On any write, ask the user which workroom β do not omit this. Optional here means the server has a fallback, not that the fallback is what anyone wanted: an omitted workroom sends the write to the account's default workroom, and accounts routinely have dozens. Creating a contact, flow, campaign or segment in the wrong workroom puts it where nobody is looking, and moving it afterwards is manual.
The one case where you need not ask: the account has exactly one workroom. Call listWorkrooms to find out β if it returns a single row, use it; if it returns several, ask which one before writing.
Reads are scoped too. Omitting a workroom on a read does not span the account β it narrows to the same default workroom a write would go to, and the response carries a workroom_defaulted warning saying so. So a count, a list or a segment preview describes one workroom unless you said otherwise. Pass all to deliberately span every workroom; that is the only way to get account-wide figures, and it is never the default. listWorkrooms itself is never narrowed, since it is how you discover what to ask for.
Also settable via ?workroom= or a workroom body field (POST/PATCH only) β query wins over header wins over body.
G Test1Duplicated calendar (inactive).
Bookable calendar ID.
cal_66d9a11d0e5b7c1a4d8e2f1ePattern: ^cal_[0-9a-fA-F]{24}$wrm_5ace370fd2a57d74d0548fb2Pattern: ^wrm_[0-9a-f]{24}$Public URL segment. Unique per workroom.
Whether this is a general workroom-wide calendar (meeting) or a personal per-staff calendar (user). Not related to how bookings are assigned across staff - see notify_type.
Public dashboard-hosted booking page. Hand this URL to end users.
Each id must be an existing staff member in this account - an id that is well-formed but doesn't exist returns a not-found error rather than being silently accepted.
Buffer between back-to-back bookings. Cannot be negative.
Minimum hours ahead a booking can be made. Cannot be negative.
The appointment type this calendar books, by id (atyp_...) or by name. An id that is well-formed but doesn't exist in this workroom returns a not-found error - it is never treated as a name. Matching by name is exact and silent: any name that does not match an existing type exactly - including a typo or near-miss - creates a brand new appointment type with no error, which can quietly fill the workroom with unwanted types. List GET /v3/appointment_types first and confirm the exact name (or that a new one is really wanted) with the user instead of guessing.
How bookings are assigned across assigned_user_ids: one at a time (roundrobin) or all of them (all). This is what the Gleantap dashboard UI itself labels "Meeting Type" - do not confuse with the meeting_type field above.
Where a booker is sent right after booking.
The resource doesn't exist or isn't visible to this caller.
POST /v3/calendars/{id}/duplicate HTTP/1.1
Host: api.gleantap.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"object": "text",
"id": "cal_66d9a11d0e5b7c1a4d8e2f1e",
"workroom_id": "wrm_5ace370fd2a57d74d0548fb2",
"name": "text",
"slug": "text",
"meeting_type": "meeting",
"status": "active",
"booking_url": "text",
"assigned_user_ids": [
"text"
],
"duration_minutes": 1,
"buffer_minutes": 1,
"minimum_booking_window": 1,
"appointment_type_id": "text",
"notify_type": "roundrobin",
"instructions": "text",
"address": "text",
"submit_button_text": "text",
"custom_redirect_url": "text",
"default_capture": [
"name"
],
"custom_questions": [
{
"label": "text",
"type": "text",
"required": false,
"options": [
"text"
]
}
],
"schedule": {
"monday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"tuesday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"wednesday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"thursday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"friday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"saturday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
],
"sunday": [
{
"from_time": "09:00",
"to_time": "17:00"
}
]
},
"confirmation": {
"type": [
"sms"
],
"email_subject": "text",
"message": "text",
"email": "text"
},
"reminders": [
{
"type": "sms",
"subject": "text",
"due_hour": "text",
"message": "text",
"email": "text"
}
],
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}