History
3 operations.
GET
/v1/history
List the account's configuration changes, newest first.
- Operation id
listHistory- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
history.read - Assistant tool
- No. Not in the first set of tools (decision 0043, point 9).
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
entity_type
|
query | string | no | |
entity_id
|
query | string | no | |
actor_type
|
query | string | no | |
actor_id
|
query | string | no | |
cursor
|
query | string | no | |
limit
|
query | string | no |
Answers
200 One page of changes. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
changes
|
array of object | yes | |
changes[]
|
object | yes | |
changes[].id
|
string | yes | |
changes[].at
|
string | yes | Limits: format date-time. |
changes[].entity_type
|
string | yes |
Values:
account
,
host
,
availability_schedule
,
calendar_connection
,
event_type
,
host_group
,
routing_form
,
booking_link
,
brand
,
text_override
,
feature_flag
,
webhook_endpoint
,
lookup_endpoint
,
api_key
,
member
.
|
changes[].entity_id
|
string | yes | |
changes[].version
|
integer | yes | |
changes[].action
|
string | yes | |
changes[].actor
|
object | yes | |
changes[].actor.type
|
string | yes |
Values:
member
,
api_key
,
system
,
support
.
|
changes[].actor.id
|
string | no | |
changes[].snapshot
|
any | yes | |
changes[].restored_from_id
|
string or null | yes | |
next_cursor
|
string or null | yes |
Refusals
| Status | Meaning | Codes |
|---|---|---|
| 400 | The request is not valid. |
invalid_request
|
| 401 | Sign in is required. |
unauthenticated
|
| 403 | You are not allowed to do that. Choose an account to act in first. |
forbidden
,
no_active_account
|
| 429 | Too many attempts. |
rate_limited
|
GET
/v1/history/{entity_type}/{entity_id}
List the changes of one thing, newest version first.
- Operation id
listEntityHistory- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
history.read - Assistant tool
- No. Not in the first set of tools (decision 0043, point 9).
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
entity_type
|
path | string | yes | |
entity_id
|
path | string | yes | Limits: 1 to 100 characters. |
cursor
|
query | string | no | |
limit
|
query | string | no |
Answers
200 One page of changes. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
changes
|
array of object | yes | |
changes[]
|
object | yes | |
changes[].id
|
string | yes | |
changes[].at
|
string | yes | Limits: format date-time. |
changes[].entity_type
|
string | yes |
Values:
account
,
host
,
availability_schedule
,
calendar_connection
,
event_type
,
host_group
,
routing_form
,
booking_link
,
brand
,
text_override
,
feature_flag
,
webhook_endpoint
,
lookup_endpoint
,
api_key
,
member
.
|
changes[].entity_id
|
string | yes | |
changes[].version
|
integer | yes | |
changes[].action
|
string | yes | |
changes[].actor
|
object | yes | |
changes[].actor.type
|
string | yes |
Values:
member
,
api_key
,
system
,
support
.
|
changes[].actor.id
|
string | no | |
changes[].snapshot
|
any | yes | |
changes[].restored_from_id
|
string or null | yes | |
next_cursor
|
string or null | yes |
Refusals
| Status | Meaning | Codes |
|---|---|---|
| 400 | The request is not valid. |
invalid_request
|
| 401 | Sign in is required. |
unauthenticated
|
| 403 | You are not allowed to do that. Choose an account to act in first. |
forbidden
,
no_active_account
|
| 429 | Too many attempts. |
rate_limited
|
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.
- Operation id
restoreFromHistory- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
history.restore - Retry key
- Required: send an Idempotency-Key header.
- Assistant tool
- No. It restores from history, which is never a tool (decision 0043, point 8).
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
history_id
|
path | string | yes | Limits: pattern ^chg_[0-9a-z]{26}$. |
Idempotency-Key
|
header | string | yes | Caller-chosen key for a safe retry. 1 to 255 visible ASCII characters. Limits: pattern ^[\u0020-\u007E]{1,255}$. |
Request body application/json, required
| Field | Type | Required | Notes |
|---|---|---|---|
version
|
integer | yes | The thing's current version, the one you read. Not the history row's version. Limits: at least 1. |
Answers
200 The history row the restore wrote. application/json
-
Header
Idempotency-Replayed: true when this answer was built from the receipt of an earlier attempt.
| Field | Type | Always sent | Notes |
|---|---|---|---|
id
|
string | yes | |
at
|
string | yes | Limits: format date-time. |
entity_type
|
string | yes |
Values:
account
,
host
,
availability_schedule
,
calendar_connection
,
event_type
,
host_group
,
routing_form
,
booking_link
,
brand
,
text_override
,
feature_flag
,
webhook_endpoint
,
lookup_endpoint
,
api_key
,
member
.
|
entity_id
|
string | yes | |
version
|
integer | yes | |
action
|
string | yes | |
actor
|
object | yes | |
actor.type
|
string | yes |
Values:
member
,
api_key
,
system
,
support
.
|
actor.id
|
string | no | |
snapshot
|
any | yes | |
restored_from_id
|
string or null | yes |
Refusals
| Status | Meaning | Codes |
|---|---|---|
| 400 | The body is not valid JSON. The request is not valid. |
invalid_json
,
invalid_request
|
| 401 | Sign in is required. |
unauthenticated
|
| 403 | You are not allowed to do that. Choose an account to act in first. |
forbidden
,
no_active_account
|
| 404 | Nothing was found there. |
not_found
|
| 409 | This cannot be done while something else depends on it. The same identifier was already used for a different request. This request is already running. This was changed by someone else since it was read. |
conflict
,
id_conflict
,
request_in_progress
,
version_conflict
|
| 415 | Send the body as JSON. |
unsupported_media_type
|
| 429 | Too many attempts. |
rate_limited
|