API reference
176 operations in 25 groups. This reference is generated from the API's OpenAPI document, Availies API, version 0.0.0. A build fails when a page here differs from that document.
Start with the overview for how to sign in, how to retry safely and how refusals look. The shared answer shapes are on one page. Times are ISO 8601 in UTC, and ids are the product's own prefixed ids.
- Health 1
- Billing 8
- Session 2
- Account 7
- Members 8
- Visitor data 2
- API keys 4
- Assistants 7
- Webhook endpoints 12
- Lookup endpoints 7
- Hosts 12
- Time off 3
- Host groups 5
- Brands 5
- Schedules 10
- Event types 13
- Booking links 8
- Link tokens 4
- Routing forms 11
- Page text 10
- Calendars 7
- Bookings 13
- History 3
- Audit log 1
- Public booking 13
Health
| Method and path | What it does |
|---|---|
GET
/health
|
Whether the service is up, which release it runs, and whether its database is ready. |
Billing
| Method and path | What it does |
|---|---|
GET
/v1/billing
|
The account's current plan and trial status. Does not call Stripe or write data. |
POST
/v1/billing/trial
|
Start the account's one card-free 30-day Team trial. |
POST
/v1/billing/free-host
|
Explicitly select the account's bookable person on Free. Does not cancel a paid subscription. |
POST
/v1/billing/refresh
|
Reconcile billing from Stripe's current state. |
POST
/v1/billing/checkout
|
Open or resume the account's single Team checkout. |
POST
/v1/billing/checkout/discard
|
Discard the exact pending checkout after Stripe confirms expiry, so its choices can be changed safely. |
POST
/v1/billing/portal
|
Open the account's Stripe billing portal. |
POST
/hooks/billing/stripe
|
Verify and reconcile an Availies Stripe event. Failed processing is retried by Stripe. |
Session
| Method and path | What it does |
|---|---|
GET
/v1/me
|
The signed-in person, their accounts, and the account this session acts in. |
POST
/v1/session/active-account
|
Chooses which of the person's accounts this session acts in. |
Account
| Method and path | What it does |
|---|---|
POST
/v1/accounts
|
Creates an account with the signed-in person as its owner, and acts in it. |
POST
/v1/account-deletion
|
Asks to delete an account the signed-in person owns, naming its handle as confirmation. The account closes at once (no pages, members, keys or assistants) and its data is purged after a grace period of 14 days, once every cancellation, email and calendar cleanup already queued has finished. Refused while the account has a pending booking or a confirmed booking that has not ended: the answer counts them. Download the account first: there is no download while it waits. |
POST
/v1/account-deletion/cancel
|
Cancels the deletion of an account the signed-in person owns, during its grace period: the account is active again, with its members, keys and assistants. Refused once the purge has started. |
GET
/v1/account
|
The account this session acts in. |
PATCH
/v1/account
|
Changes the account's handle, name, time zone, default language, enabled languages, its two email settings (the host notice and the calendar file on a cancellation), whether changes made in a host's calendar flow back into the booking, how long visitor data is kept after a meeting, the sites that may show its booking pages in a frame, or the hosts its after-booking redirects may go to. |
PUT
/v1/account/host-limit-defaults
|
Replaces the account's default for each host's own booking limits, and optionally the Monday two-week limits are counted from. A host's own limit for a period replaces the default for that period. Send the whole list and the account version you read. Changing the starting Monday also needs account.update. |
GET
/v1/account/export
|
Downloads everything the account holds as one JSON Lines file: one line per row, {"table": ..., "row": {...}}, the account's own row first, and last a trailer with the rows written per table and "complete": true. A file without the trailer is incomplete: download it again. Instants are ISO 8601 UTC strings. Secrets are never written. It is a live read: a row changed during the download may appear as it was before or after the change. |
Members
| Method and path | What it does |
|---|---|
GET
/v1/members
|
The members of the account. |
PATCH
/v1/members/{id}
|
Changes a member's role. |
DELETE
/v1/members/{id}
|
Removes a member from the account. The person and their other accounts stay. Invites the member sent stay valid until they are revoked. |
GET
/v1/invites
|
The account's invites, newest first: pending ones and those that ended in the last 30 days, each with its state. |
POST
/v1/invites
|
Invites a person by email address, as an admin or a member, and sends the invite email. The link works for 7 days. An invite stays valid if the member who sent it is removed; revoke it to stop it. |
POST
/v1/invites/{invite_id}/resend
|
Sends a pending invite again with a new link. The old link stops working, and the 7 days start again. Counts against the hourly limit of invite emails. |
POST
/v1/invites/{invite_id}/revoke
|
Revokes a pending invite. Its link stops working at once. |
POST
/v1/invites/accept
|
Accepts an invite for the signed-in person, whose address must be the invited one. Makes them a member with the invited role. It does not change which account the session acts in. |
Visitor data
| Method and path | What it does |
|---|---|
POST
/v1/visitor-data/find
|
Finds everything the account holds for one visitor's email address, to answer that person's request to see their data: the bookings they made and were a guest of, routing form answers, emails sent to them, prefilled links and assistant calls that name them, and webhook events about them. The answer is a JSON file to hand to the person. It lists the bookings that cannot be erased yet, and what is not the product's to erase. The address is in the body, never in the path; the audit log records counts only. |
POST
/v1/visitor-data/erase
|
Erases what the account holds for one visitor's email address (decision 0045, points 15 to 18). A booking the visitor made keeps its time, host and status and loses the visitor's details; a booking they were a guest of loses only their guest entry; webhook events about them are deleted with their deliveries; emails to them keep no address or message; prefilled links and assistant calls that name them are deleted; routing form answers are emptied. A pending booking, a booking whose meeting has not ended, and a booking whose cancellation is still being carried out are not erased: they are listed, so they can be cancelled or waited for. Data already delivered to the account's own systems and meetings in the hosts' calendars are not the product's to erase; the answer counts them. Safe to repeat. The address is in the body, never in the path; the audit log records counts only. |
API keys
| Method and path | What it does |
|---|---|
GET
/v1/api-keys
|
The account's API keys, newest first: active, expired and revoked, each with its scopes, who made it and when it was last used. Never a key itself. |
POST
/v1/api-keys
|
Makes an API key and answers it once. Its scopes must be permissions you hold now, not only ones that reach the host linked to you, and cannot include managing keys. It expires at the time you choose, or never if you leave the expiry out. |
DELETE
/v1/api-keys/{api_key_id}
|
Revokes an API key. It stops working on the next request. The key stays in the list as revoked. Revoking a revoked key changes nothing. |
GET
/v1/api-key/self
|
Lists only the authenticating API key's effective permission names. |
Assistants
| Method and path | What it does |
|---|---|
GET
/v1/assistant-consent
|
What an assistant asks for: its claimed name, its address host, the redirect address, the permissions, and your accounts with what you may give in each. Read from the signed request the authorization server sent the consent page. |
POST
/v1/assistant-consent
|
Answers an assistant's request. Accepting connects it to one of your accounts with the permissions you chose (from what it asked for and you hold), and replaces any earlier connection of the same assistant there. Declining tells it no. Either way, send the browser to redirect_to. |
GET
/v1/assistant-grants
|
Connected assistants, newest first: yours, or every member's with assistant_grants.read. Each with the assistant's claimed name and host, the redirect host, the permissions, when it was connected and last used, and when it expires. |
DELETE
/v1/assistant-grants/{assistant_grant_id}
|
Disconnects an assistant: yours, or any member's with assistant_grants.manage. It stops on its next request and its next refresh. The grant stays in the list as revoked. Revoking a revoked grant changes nothing. |
GET
/v1/assistant-approvals
|
Your pending assistant approvals, newest first. API keys and assistant calls receive an empty page; only your own member session sees approvals. Support access is refused. |
GET
/v1/assistant-approvals/{approval_id}
|
One call an assistant asked to make for you, waiting for your approval: what it will do, read by the server now, and the arguments it sent. Only the member the assistant acts for can read it. |
POST
/v1/assistant-approvals/{approval_id}/decision
|
Approve or decline one call an assistant asked to make for you. Approving lets the assistant run exactly that call, once, before the approval expires. Only the member the assistant acts for can decide, once. |
Webhook endpoints
| Method and path | What it does |
|---|---|
GET
/v1/webhook-endpoints
|
The account's webhook endpoints, oldest first. Never a signing secret. |
POST
/v1/webhook-endpoints
|
Adds a webhook endpoint, switched on, and answers its signing secret once. The address is checked as written and through DNS; a refused address answers 400 with a reason. An account has at most 20 endpoints, switched on or off; one more answers 400. |
GET
/v1/webhook-endpoints/{webhook_endpoint_id}
|
One webhook endpoint. Never its signing secret. |
PATCH
/v1/webhook-endpoints/{webhook_endpoint_id}
|
Changes a webhook endpoint's address, description, events or report system, or switches it on or off. Send the version you read. A new address, and switching an endpoint on, check the address again. |
DELETE
/v1/webhook-endpoints/{webhook_endpoint_id}
|
Deletes a webhook endpoint. Send the version you read. |
POST
/v1/webhook-endpoints/{webhook_endpoint_id}/rotate-secret
|
Replaces the signing secret and answers the new one once. Send the version you read. By default the old secret keeps working for 24 hours and deliveries carry both signatures; a rotation during that time drops the older secret. |
GET
/v1/webhook-endpoints/{webhook_endpoint_id}/deliveries
|
One endpoint's deliveries, newest first, optionally of one status. Pass next_cursor as cursor for the next page. |
GET
/v1/webhook-deliveries/{webhook_delivery_id}/attempts
|
One delivery and every attempt it made, in order: when, how long, the status and an error code. Never a response body. |
POST
/v1/webhook-deliveries/{webhook_delivery_id}/replay
|
Sends a dead (or skipped) delivery again: the same id and the same bytes, with a fresh retry schedule. Deliveries of the same booking that waited behind it follow in order. |
POST
/v1/webhook-deliveries/{webhook_delivery_id}/skip
|
Gives up a dead delivery on purpose. The deliveries of the same booking that waited behind it go on. A skipped delivery can still be replayed. |
POST
/v1/webhook-endpoints/{webhook_endpoint_id}/replay
|
Sends the dead deliveries of this endpoint made in a time range again, oldest first, each with a fresh retry schedule: at most 500 a call. Answers how many, and more when some are left: call it again for the rest. |
POST
/v1/webhook-endpoints/{webhook_endpoint_id}/test
|
Sends a test event (webhook.test, a fixed body that names no booking and no person) to the endpoint now, signed like every delivery, and answers how it went. Nothing is stored or retried. |
Lookup endpoints
| Method and path | What it does |
|---|---|
GET
/v1/lookup-endpoints
|
The account's lookup endpoints, oldest first. Never a signing secret. |
POST
/v1/lookup-endpoints
|
Adds a lookup endpoint, switched on, and answers its signing secret once. The address is checked as written and through DNS; a refused address answers 400 with a reason. |
GET
/v1/lookup-endpoints/{lookup_endpoint_id}
|
One lookup endpoint with its recent outcomes by kind. Never its signing secret, never a request or an answer. |
PATCH
/v1/lookup-endpoints/{lookup_endpoint_id}
|
Changes a lookup endpoint's name, address, budget or failure setting, or switches it on or off. Send the version you read. The purpose never changes. A new address, and switching an endpoint on, check the address again. |
DELETE
/v1/lookup-endpoints/{lookup_endpoint_id}
|
Deletes a lookup endpoint. Send the version you read. An endpoint a routing rule names is refused (409 lookup_in_use): change the rule first, or switch the endpoint off. |
POST
/v1/lookup-endpoints/{lookup_endpoint_id}/rotate-secret
|
Replaces the signing secret and answers the new one once. Send the version you read. By default the old secret keeps working for 24 hours and requests carry both signatures. |
POST
/v1/lookup-endpoints/{lookup_endpoint_id}/test
|
Calls the endpoint now with synthetic input (operation test), signed and timed exactly like a real lookup, and answers the parsed answer or why it failed. Nothing is stored, counted or retried beyond the one retry a lookup makes, and the failure setting is not applied. An answer larger than 16 KB fails. |
Hosts
| Method and path | What it does |
|---|---|
GET
/v1/hosts
|
The account's hosts, newest first. |
POST
/v1/hosts
|
Adds a host. The host's default schedule is created with it, with Monday to Friday, 09:00 to 17:00, in the host's time zone. |
GET
/v1/hosts/{host_id}
|
One host, archived or not. |
PATCH
/v1/hosts/{host_id}
|
Changes a host. Send the version you read. A member may change the name and time zone of the host linked to them. Activation is applied after the profile. |
PUT
/v1/hosts/{host_id}/limits
|
Replaces a host's own booking limits: at most so many bookings a day, a week (Monday to Sunday), two weeks (fixed blocks from a starting Monday) or a month, in the host's time zone, across every event type that counts toward them. Each replaces the account's default for its period; a null maximum means no limit in that period. Send the whole list and the version you read; an empty list clears it, so the account's defaults apply. Optionally sets the host's own starting Monday. A member may change the limits of the host linked to them. |
GET
/v1/me/host-limits
|
The booking limits of the host linked to the caller, and how many places are used and left in the current periods. Null when no host is linked to the caller (a key never has one). Counts only: never which bookings, never an event type's total, never another host. |
GET
/v1/hosts/{host_id}/limit-usage
|
One host's booking limits and how many places are used and left in the current periods. Counts only, never which bookings. |
POST
/v1/hosts/{host_id}/archive
|
Archives a host. The row stays, and so do the host's schedules. An archived host cannot be changed. |
POST
/v1/hosts/{host_id}/restore
|
Brings an archived host back. Refused when another host now has this email or member link. |
PUT
/v1/hosts/{host_id}/external-ids/{system}
|
Gives a host its id in another system, such as the user id a CRM has for this person. Send the id you last saw for this host and system (null for none). One id names one host per system: an id another host has is refused, never moved. An archived host takes no new id. Not part of the host's version. |
POST
/v1/hosts/{host_id}/external-ids/{system}/remove
|
Removes a host's id in another system. Send the id you last saw. An archived host's ids can be removed. The id travels in the body, never in the address, because it names a person's account in that system. |
GET
/v1/hosts/{host_id}/busy
|
When one host is busy in a range: spans only, never what fills them. For a system that draws its own calendar; a booking checks the time again. |
Time off
| Method and path | What it does |
|---|---|
GET
/v1/hosts/{host_id}/time-off
|
Time off for one host that overlaps the asked range. |
POST
/v1/hosts/{host_id}/time-off
|
Records time off for a host. A member linked to the host may do this. |
DELETE
/v1/time-off/{time_off_id}
|
Removes one block of time off. A member linked to the host may do this. |
Host groups
| Method and path | What it does |
|---|---|
GET
/v1/host-groups
|
The account's host groups, by name, each with its members. |
POST
/v1/host-groups
|
Adds a host group. Members are hosts of this account that are not archived. A group may start empty. |
GET
/v1/host-groups/{host_group_id}
|
One host group, with its members. |
PATCH
/v1/host-groups/{host_group_id}
|
Renames a host group, changes its description, or replaces its members. Send the version you read. A member change that would leave an active event type with no bookable host is refused, and nothing is saved. |
DELETE
/v1/host-groups/{host_group_id}
|
Deletes a host group, its members and its assignments to event types. Bookings are not touched. Refused while it would leave an active event type with no bookable host. |
Brands
| Method and path | What it does |
|---|---|
GET
/v1/brands
|
The account's brands, the default first, then by name. |
POST
/v1/brands
|
Adds a brand. The account's first brand is its default. A primary colour the palette rule refuses is refused, with the nearest colour that passes. |
GET
/v1/brands/{brand_id}
|
One brand. |
PATCH
/v1/brands/{brand_id}
|
Changes a brand, or makes it the default. Send the version you read. A primary colour the palette rule refuses is refused, with the nearest colour that passes, and nothing is saved. |
DELETE
/v1/brands/{brand_id}
|
Deletes a brand that is not the default. Every event type that named it wears the default brand from then on, each with a new version. The default brand is refused: make another brand the default first. |
Schedules
| Method and path | What it does |
|---|---|
GET
/v1/hosts/{host_id}/schedules
|
The schedules of one host, oldest first, with weekly hours and date overrides. |
POST
/v1/hosts/{host_id}/schedules
|
Adds a schedule for a host. It is not the default. A member linked to the host may do this. |
GET
/v1/schedules/{schedule_id}
|
One schedule, with its weekly hours and date overrides. A schedule with no host is an event type's own hours. |
PATCH
/v1/schedules/{schedule_id}
|
Changes a schedule's name, time zone or default flag. A member linked to the host may do this. An event type's own hours need the right to change event types. |
DELETE
/v1/schedules/{schedule_id}
|
Removes a schedule that is not the default and is not used by an event type. A member linked to the host may do this. An event type's own hours need the right to change event types. |
PUT
/v1/schedules/{schedule_id}/hours
|
Replaces the whole week. Every weekday is required, and an empty day is closed. An event type's own hours keep at least one range. A member linked to the host may do this. An event type's own hours need the right to change event types. |
PUT
/v1/schedules/{schedule_id}/overrides/{date}
|
Sets the hours of one date. An empty list closes that day. A member linked to the host may do this. An event type's own hours need the right to change event types. |
DELETE
/v1/schedules/{schedule_id}/overrides/{date}
|
Removes one date override, so that date follows the weekly hours again. A member linked to the host may do this. An event type's own hours need the right to change event types. |
POST
/v1/event-types/{event_type_id}/schedule
|
Gives an event type hours of its own. They replace every host's hours for this event type; each host's calendar and time off still block. Send the event type's version. Change them afterwards through the schedule routes. |
DELETE
/v1/event-types/{event_type_id}/schedule
|
Removes an event type's own hours, so each host's hours apply again. Send the event type's version. An event type without hours of its own answers the same, and nothing changes. |
Event types
| Method and path | What it does |
|---|---|
GET
/v1/event-types
|
The account's event types, in their stored order. |
POST
/v1/event-types
|
Adds an event type. It starts off, and its public path is chosen from the name. |
GET
/v1/event-types/{event_type_id}
|
One event type, archived or not, with its hosts, host groups, pauses, locations, questions and pages. |
PATCH
/v1/event-types/{event_type_id}
|
Changes an event type. Send the version you read. Turning it on is refused, and nothing else is saved, when a host or a location is still missing. Turning it off is refused while a switched-on routing form sends visitors to it. A brand_id must name a brand of this account; another account's brand answers not found. A confirmation_redirect_url whose host the account does not allow is refused, and nothing is saved. |
POST
/v1/event-types/{event_type_id}/archive
|
Archives an event type and switches its booking links off. The row stays. Refused while a switched-on routing form sends visitors to it. |
POST
/v1/event-types/{event_type_id}/restore
|
Brings an archived event type back. Links that were switched off stay off. |
POST
/v1/event-types/{event_type_id}/clone
|
Copies an event type: its settings, hosts, host groups, questions, locations, limits and its own hours (as a new schedule). The copy is switched off and named "Copy of" and the name. Booking links, pauses, bookings and history are not copied. |
PUT
/v1/event-types/{event_type_id}/hosts
|
Replaces the hosts of an event type. Send the whole list and the version you read. |
PUT
/v1/event-types/{event_type_id}/host-groups
|
Replaces the host groups of an event type. Send the whole list and the version you read. A host assigned directly keeps the direct row's priority and weight. |
PUT
/v1/event-types/{event_type_id}/pauses
|
Replaces the pauses of an event type: hosts who stay assigned but get no bookings of it until the pause ends. Send the whole list; an empty list clears it. Pausing the last bookable host of an active event type is refused. Unpausing never is. |
PUT
/v1/event-types/{event_type_id}/locations
|
Replaces the locations. Send the whole list. An entry that carries its id keeps that id. |
PUT
/v1/event-types/{event_type_id}/limits
|
Replaces the booking limits of an event type. Send the whole list and the version you read; an empty list clears it. At most one limit for each kind and period. A day, a week (Monday to Sunday), two weeks (fixed blocks from a starting Monday) and a month are local calendar periods: each host's own time zone and starting Monday for per_host, the account's for total. |
PUT
/v1/event-types/{event_type_id}/questions
|
Replaces the questions. Send the whole list. An entry that carries its id keeps that id. |
Booking links
| Method and path | What it does |
|---|---|
GET
/v1/links
|
The account's booking links, in path order. |
POST
/v1/links
|
Adds a booking link to an event type, a host, a routing form or another address. The path is stored as a slug. A second link to the same event type, host or form is an extra path, not a second canonical one. With origin: import and an old address it is a legacy link, created off. |
POST
/v1/links/legacy-batch
|
Makes up to 100 legacy links in one write, each off and forwarding to its old address, and answers each new address in item order. A path is the item's own or made from the old address's path. A path that is invalid, reserved, taken, given twice, or under a host's own path refuses the whole batch, naming each item in its issues; nothing is made and nothing is suffixed. |
POST
/v1/links/legacy-switch
|
Turns up to 25 legacy links on or off in one write, all or none. Each item names a link, the version you read and the state wanted. A link is turned on only when its target can take bookings now: an event type that is on, shown on a booking page, with a host who can be booked, has hours and a connected calendar; a routing form that is on, whose every event type passes the same check. Turning off is never refused for that. Any refused item refuses the whole switch, naming each item in its issues; nothing changes. Each link gets a new version, a history row and an audit row. To go back, turn them off again, or restore an earlier version from the history. |
GET
/v1/links/path-check
|
Whether a path can be saved in this account. The answer is the slug the path would be stored as. |
GET
/v1/links/{link_id}
|
One booking link, including the other paths that open the same target. |
PATCH
/v1/links/{link_id}
|
Changes a booking link. Send the version you read. A new path keeps the old one as an alias. The redirect address itself is chosen at creation. A legacy link's old address can be replaced, never cleared. A legacy link is turned on only when its target can take bookings now; the refusal names why under json.is_active. |
DELETE
/v1/links/{link_id}
|
Removes an old path. The canonical link stays. |
Link tokens
| Method and path | What it does |
|---|---|
GET
/v1/link-tokens
|
The account's prefilled links, newest first, with their visitor's details and state. Never a link's token. Pass next_cursor as cursor for the next page. |
POST
/v1/link-tokens
|
Mints a prefilled link that books one event type once, for one visitor, and answers its address once. Needs the right to book for a visitor with the pinned host (or any host); vouch also needs bookings.read and bookings.manage. |
DELETE
/v1/link-tokens/{link_token_id}
|
Revokes an unused prefilled link: it stops working at once. A link a booking holds cannot be revoked; cancel the booking instead. Revoking a revoked link changes nothing. |
POST
/v1/link-tokens/resolve
|
Reads the state and bound booking of one exact prefilled token. A key also needs bookings.read. An active result is only a snapshot and does not prove that no booking is in progress. |
Routing forms
| Method and path | What it does |
|---|---|
GET
/v1/routing-forms
|
The account's routing forms, by name, each with its questions and rules. |
POST
/v1/routing-forms
|
Adds a routing form with no questions and no rules. It starts switched off; add a fallback event type before switching it on. |
POST
/v1/routing-forms/import
|
Creates a new, switched-off routing form from an export document. It is checked as switching it on would be, and every event type and host group it names must be this account's. It never changes an existing form. |
GET
/v1/routing-forms/{routing_form_id}
|
One routing form, archived or not, with its questions and rules. |
PATCH
/v1/routing-forms/{routing_form_id}
|
Changes the name, the fallback event type or whether the form is switched on. Send the version you read. A form that is on after the change needs a fallback, and every event type it sends visitors to must be switched on and not archived; otherwise nothing is saved. |
GET
/v1/routing-forms/{routing_form_id}/submissions
|
One routing form's submissions, newest first: what each visitor answered, where the form sent them, and the booking they made. |
GET
/v1/routing-forms/{routing_form_id}/export
|
One routing form as a portable document: questions keyed q1, q2 in order, conditions naming those keys, destinations by id. |
POST
/v1/routing-forms/{routing_form_id}/archive
|
Archives a routing form and switches its booking links off. The rows stay. |
POST
/v1/routing-forms/{routing_form_id}/restore
|
Brings an archived routing form back. Links that were switched off stay off. |
PUT
/v1/routing-forms/{routing_form_id}/questions
|
Replaces the questions. Send the whole ordered list and the version you read. An entry that carries its id keeps that id. A list that would leave a rule naming a question it removes is refused. |
PUT
/v1/routing-forms/{routing_form_id}/rules
|
Replaces the rules. Send the whole list in the order they are tried, and the version you read; the first matching rule wins. An entry that carries its id keeps that id. Every condition is checked, and every event type and host group must be this account's. |
Page text
| Method and path | What it does |
|---|---|
GET
/v1/page-text/catalog
|
The page text an account may change: each overridable key by panel, with its label, length cap, placeholders, whether it may be hidden and its default in every language; and every locked key with the reason it is locked. |
POST
/v1/page-text/preview
|
Resolves a page's sentences in one language with a draft list in place of one scope's stored list, and says what a save of the draft would refuse. Nothing is stored. An event type needs event_types.read too, a routing form routing_forms.read. |
GET
/v1/account/page-text/{locale}
|
The account's own page text in one language, or in every language (*). |
PUT
/v1/account/page-text/{locale}
|
Replaces the account's own page text in one language, or in every language (*). Send the whole list and the account's version. A locked or unknown key, a text with other placeholders than the default, markup or a link refuses the whole list. |
GET
/v1/brands/{brand_id}/page-text/{locale}
|
A brand's page text in one language, or in every language (*). |
PUT
/v1/brands/{brand_id}/page-text/{locale}
|
Replaces a brand's page text in one language, or in every language (*). Send the whole list and the brand's version. |
GET
/v1/event-types/{event_type_id}/page-text/{locale}
|
An event type's page text in one language, or in every language (*). |
PUT
/v1/event-types/{event_type_id}/page-text/{locale}
|
Replaces an event type's page text in one language, or in every language (*). Send the whole list and the event type's version. An archived event type is not changed. |
GET
/v1/routing-forms/{routing_form_id}/page-text/{locale}
|
A routing form's page text in one language, or in every language (*), with its message rules' messages in that language. |
PUT
/v1/routing-forms/{routing_form_id}/page-text/{locale}
|
Replaces a routing form's page text in one language, or in every language (*), together with its message rules' messages in that language (routingMessage entries with a rule_id; never in the account's default language or *). Send the whole list and the routing form's version. An archived routing form is not changed. |
Calendars
| Method and path | What it does |
|---|---|
POST
/v1/hosts/{host_id}/calendar-connections/google/start
|
Starts connecting a host's Google calendar. Answers the address the browser opens. A member linked to the host may do this. |
GET
/v1/oauth/google/callback
|
Google sends the browser here after consent. The same member must still be signed in. The browser is then sent back to the app. |
GET
/v1/hosts/{host_id}/calendar-connections
|
A host's calendar connections, and the calendars on each one. |
PUT
/v1/calendar-connections/{connection_id}/calendars
|
Chooses which calendars block time and which one receives bookings. A member linked to the host may do this. |
POST
/v1/calendar-connections/{connection_id}/refresh-calendars
|
Reads the calendar list from the provider again. New calendars are not selected. A member linked to the host may do this. |
DELETE
/v1/calendar-connections/{connection_id}
|
Removes a calendar connection and asks the provider to revoke the grant. A member linked to the host may do this. |
POST
/hooks/calendar/google/{account_id}
|
Google's notice that a watched calendar changed. Answers 204 whatever it carries; a valid one only schedules a sync. |
Bookings
| Method and path | What it does |
|---|---|
GET
/v1/bookings/export.csv
|
Download bookings as a spreadsheet. |
GET
/v1/bookings/summary
|
Booking activity over account-local calendar days ending today, and confirmed starts in the next 168 hours. |
GET
/v1/bookings
|
List bookings by start and id, descending by default or ascending with order=asc. |
POST
/v1/bookings
|
Book a time the host offers, for a visitor. The same operation the booking page uses. |
GET
/v1/bookings/{booking_id}
|
Read one booking. |
GET
/v1/bookings/{booking_id}/timeline
|
What happened to one booking, oldest first. |
GET
/v1/bookings/{booking_id}/slots
|
Free times this booking can move to. Its own time does not block it. |
GET
/v1/event-types/{event_type_id}/slots
|
Free times of one event type, for booking on behalf of a visitor. |
POST
/v1/bookings/{booking_id}/cancel
|
Cancel a booking. The same operation a visitor uses. |
POST
/v1/bookings/{booking_id}/reschedule
|
Move a booking to a time the host offers. The same operation a visitor uses. |
POST
/v1/bookings/{booking_id}/outcome
|
Record whether the visitor attended. |
POST
/v1/bookings/{booking_id}/reassign
|
Reassign a booking to another host, at the same time. |
PUT
/v1/bookings/{booking_id}/reports/{system}
|
Report what your system did with one version of a booking: done, skipped or failed. Not a change to the booking: it writes no version and sends no event. |
History
| Method and path | What it does |
|---|---|
GET
/v1/history
|
List the account's configuration changes, newest first. |
GET
/v1/history/{entity_type}/{entity_id}
|
List the changes of one thing, newest version first. |
POST
/v1/history/{history_id}/restore
|
Sets a thing back to the state one history row holds, as a new change: the same checks as a save, one new version, and a history row that names the row it came from. Send the thing's current version. Event types, hosts, schedules, booking links, host groups, routing forms and brands can be restored; a brand's restore never changes which brand is the default. An event type, routing form or brand gets back the page text it had then. The archive state is never changed, and bookings are never touched. |
Audit log
| Method and path | What it does |
|---|---|
GET
/v1/audit-log
|
List the account's audit log, newest first. |
Public booking
| Method and path | What it does |
|---|---|
GET
/v1/public/accounts/{handle}/link
|
What a visitor sees for a booking path: the event type, a routing form, a redirect, or nothing. |
GET
/v1/public/accounts/{handle}/event-types/{event_type_id}/slots
|
Free times a visitor can book for one event type. |
POST
/v1/public/accounts/{handle}/event-types/{event_type_id}/slots
|
Free times for a booking being moved. The reschedule token is in the body. |
POST
/v1/public/accounts/{handle}/bookings
|
Book a time. |
GET
/v1/public/accounts/{handle}/bookings/{booking_id}
|
Read a booking with its manage token. |
POST
/v1/public/accounts/{handle}/bookings/{booking_id}
|
Read a booking with its manage token in the body. |
GET
/v1/public/accounts/{handle}/bookings/{booking_id}/calendar-file
|
Download the calendar file for a booking. |
POST
/v1/public/accounts/{handle}/bookings/{booking_id}/calendar-file
|
Download the calendar file for a booking. The manage token is in the body. |
POST
/v1/public/accounts/{handle}/bookings/{booking_id}/cancel
|
Cancel a booking with its cancel token. |
POST
/v1/public/accounts/{handle}/bookings/{booking_id}/reschedule
|
Move a booking to a new time with its reschedule token. |
POST
/v1/public/manage/read
|
Read a manage page for its token. A manage link is a secret. The token is sent in the body, never in the URL. |
POST
/v1/public/accounts/{handle}/routing-forms/{routing_form_id}/submissions
|
Submit a routing form and learn where to go next. |
POST
/v1/public/accounts/{handle}/page-reports
|
Report a booking page to the product's operator, with a reason: deceptive (asks for a password, a payment or personal details under a false pretence), impersonation, spam, harmful, or other. Nothing about the person reporting is stored. |
Shared shapes: Account, Booking, BookingActivitySummary, BookingLink, BookingSummary, EventType, Host, HostBusy, Member, Schedule, TimeOff.