Visitor data
2 operations.
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.
- Operation id
findVisitorData- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
visitor_data.manage - Assistant tool
- No. It reads or erases everything one visitor left with the account, which is a member's answer to that person, never an assistant's (decision 0045, points 14 to 17).
Request body application/json, required
| Field | Type | Required | Notes |
|---|---|---|---|
email
|
string | yes | The visitor's email address. Compared without regard to letter case. Limits: at most 320 characters. |
Answers
200 The visitor's data, as a file. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
format
|
string | yes |
Values:
availies-visitor-data/1
.
|
account_id
|
string | yes | |
email
|
string | yes | |
found_at
|
string | yes | Limits: format date-time. |
bookings
|
array of object | yes | Bookings the visitor made: their own details, and each booking's time, event type and host. |
bookings[]
|
object | yes | |
bookings[].id
|
string | yes | |
bookings[].status
|
string | yes | |
bookings[].start_at
|
string | yes | Limits: format date-time. |
bookings[].end_at
|
string | yes | Limits: format date-time. |
bookings[].created_at
|
string | yes | Limits: format date-time. |
bookings[].event_type
|
object | yes | |
bookings[].event_type.id
|
string | yes | |
bookings[].event_type.name
|
string or null | yes | |
bookings[].host
|
object | yes | |
bookings[].host.id
|
string | yes | |
bookings[].host.name
|
string or null | yes | |
bookings[].invitee
|
object | yes | |
bookings[].invitee.name
|
string or null | yes | |
bookings[].invitee.email
|
string or null | yes | |
bookings[].invitee.phone
|
string or null | yes | |
bookings[].invitee.time_zone
|
string or null | yes | |
bookings[].location
|
object | yes | |
bookings[].location.kind
|
string | yes | |
bookings[].location.value
|
string or null | yes | |
bookings[].meeting_url
|
string or null | yes | |
bookings[].cancel_reason
|
string or null | yes | |
bookings[].external_ref
|
string or null | yes | |
bookings[].attribution
|
any | yes | |
bookings[].answers
|
array of object | yes | |
bookings[].answers[]
|
object | yes | |
bookings[].answers[].label
|
string | yes | |
bookings[].answers[].kind
|
string | yes | |
bookings[].answers[].text
|
string or null | yes | |
bookings[].answers[].value
|
any | yes | |
bookings[].calendar_meeting_urls
|
array of string or null | yes | |
bookings[].report_ids
|
array of object | yes | |
bookings[].report_ids[]
|
object | yes | |
bookings[].report_ids[].system
|
string | yes | |
bookings[].report_ids[].external_id
|
string or null | yes | |
guest_of
|
array of object | yes | Bookings the visitor was a guest of: only the visitor's own guest details. |
guest_of[]
|
object | yes | |
guest_of[].booking_id
|
string | yes | |
guest_of[].status
|
string | yes | |
guest_of[].start_at
|
string | yes | Limits: format date-time. |
guest_of[].end_at
|
string | yes | Limits: format date-time. |
guest_of[].event_type
|
object | yes | |
guest_of[].event_type.id
|
string | yes | |
guest_of[].event_type.name
|
string or null | yes | |
guest_of[].host
|
object | yes | |
guest_of[].host.id
|
string | yes | |
guest_of[].host.name
|
string or null | yes | |
guest_of[].guest
|
object | yes | |
guest_of[].guest.email
|
string | yes | |
guest_of[].guest.name
|
string or null | yes | |
routing_submissions
|
array of object | yes | |
routing_submissions[]
|
object | yes | |
routing_submissions[].id
|
string | yes | |
routing_submissions[].routing_form_id
|
string | yes | |
routing_submissions[].submitted_at
|
string | yes | Limits: format date-time. |
routing_submissions[].email
|
string or null | yes | |
routing_submissions[].answers
|
any | yes | |
routing_submissions[].attribution
|
any | yes | |
routing_submissions[].external_ref
|
string or null | yes | |
routing_submissions[].booking_id
|
string or null | yes | |
emails
|
array of object | yes | Emails sent to the visitor. |
emails[]
|
object | yes | |
emails[].id
|
string | yes | |
emails[].booking_id
|
string or null | yes | |
emails[].template
|
string | yes | |
emails[].status
|
string | yes | |
emails[].recipient_role
|
string | yes | |
emails[].created_at
|
string | yes | Limits: format date-time. |
emails[].sent_at
|
string or null | yes | Limits: format date-time. |
prefilled_links
|
array of object | yes | |
prefilled_links[]
|
object | yes | |
prefilled_links[].id
|
string or null | yes | |
prefilled_links[].booking_id
|
string or null | yes | |
prefilled_links[].created_at
|
string | yes | Limits: format date-time. |
prefilled_links[].expires_at
|
string | yes | Limits: format date-time. |
prefilled_links[].revoked_at
|
string or null | yes | Limits: format date-time. |
prefilled_links[].used
|
boolean | yes | |
prefilled_links[].prefilled
|
object | yes | |
prefilled_links[].prefilled.email
|
string | yes | |
prefilled_links[].prefilled.name
|
string or null | yes | |
prefilled_links[].prefilled.phone
|
string or null | yes | |
prefilled_links[].prefilled.external_ref
|
string or null | yes | |
prefilled_links[].prefilled.answers
|
any | yes | |
assistant_approvals
|
array of object | yes | Assistant calls that named the visitor, listed without their arguments, which may name others. |
assistant_approvals[]
|
object | yes | |
assistant_approvals[].id
|
string | yes | |
assistant_approvals[].operation
|
string | yes | |
assistant_approvals[].created_at
|
string | yes | Limits: format date-time. |
assistant_approvals[].decision
|
string or null | yes | |
assistant_approvals[].used_at
|
string or null | yes | Limits: format date-time. |
webhook_events
|
array of object | yes | Webhook events about the visitor's bookings and forms, listed without their bodies, which may name others. |
webhook_events[]
|
object | yes | |
webhook_events[].id
|
string | yes | |
webhook_events[].type
|
string | yes | |
webhook_events[].occurred_at
|
string | yes | Limits: format date-time. |
webhook_events[].delivered
|
integer | yes | |
not_erasable_now
|
array of object | yes | |
not_erasable_now[]
|
object | yes | |
not_erasable_now[].booking_id
|
string | yes | |
not_erasable_now[].status
|
string | yes | |
not_erasable_now[].start_at
|
string | yes | Limits: format date-time. |
not_erasable_now[].end_at
|
string | yes | Limits: format date-time. |
not_erasable_now[].reason
|
string | yes |
Why it is not erased now: pending (not confirmed yet), upcoming (its meeting has not ended), work_pending (a cancellation, email, calendar cleanup or webhook for it is still running). Cancel it, or wait, and ask again.
Values:
pending
,
upcoming
,
work_pending
.
|
not_ours
|
object | yes | What is not the product's to erase (decision 0045, point 18): data already delivered to the account's own systems, and the hosts' calendars. The account erases those itself. |
not_ours.webhook_deliveries
|
integer | yes | Webhook deliveries of this visitor's events that reached the account's own systems. |
not_ours.calendar_events
|
integer | yes | Meetings of this visitor's bookings in the hosts' calendars. |
not_ours.lookup_endpoints
|
integer | yes | The account's lookup endpoints, which may have been sent this visitor's details. |
counts
|
map of text to integer | 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
|
| 415 | Send the body as JSON. |
unsupported_media_type
|
| 422 | The account holds too much to answer this request in one go. |
visitor_data_too_large
|
| 429 | Too many attempts. |
rate_limited
|
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.
- Operation id
eraseVisitorData- Who can call it
- Acts in one account, the one the credential belongs to.
- Credentials
- session or API key
- Permission
-
visitor_data.manage - Assistant tool
- No. It reads or erases everything one visitor left with the account, which is a member's answer to that person, never an assistant's (decision 0045, points 14 to 17).
Request body application/json, required
| Field | Type | Required | Notes |
|---|---|---|---|
email
|
string | yes | The visitor's email address. Compared without regard to letter case. Limits: at most 320 characters. |
Answers
200 What was erased, and what was not. application/json
| Field | Type | Always sent | Notes |
|---|---|---|---|
erased
|
object | yes | What was erased, by kind. |
erased.bookings
|
integer | yes | Bookings whose visitor details were erased; the booking itself stays. |
erased.guest_rows
|
integer | yes | |
erased.routing_submissions
|
integer | yes | |
erased.emails_to_visitor
|
integer | yes | |
erased.emails_to_others
|
integer | yes | Emails of the visitor's bookings to someone else, whose stored message was erased. |
erased.prefilled_links
|
integer | yes | |
erased.assistant_approvals
|
integer | yes | |
erased.webhook_events
|
integer | yes | |
erased.webhook_deliveries
|
integer | yes | |
complete
|
boolean | yes | False when part of the data changed while it was being erased and was left alone. Ask again. |
not_erasable_now
|
array of object | yes | |
not_erasable_now[]
|
object | yes | |
not_erasable_now[].booking_id
|
string | yes | |
not_erasable_now[].status
|
string | yes | |
not_erasable_now[].start_at
|
string | yes | Limits: format date-time. |
not_erasable_now[].end_at
|
string | yes | Limits: format date-time. |
not_erasable_now[].reason
|
string | yes |
Why it is not erased now: pending (not confirmed yet), upcoming (its meeting has not ended), work_pending (a cancellation, email, calendar cleanup or webhook for it is still running). Cancel it, or wait, and ask again.
Values:
pending
,
upcoming
,
work_pending
.
|
not_ours
|
object | yes | What is not the product's to erase (decision 0045, point 18): data already delivered to the account's own systems, and the hosts' calendars. The account erases those itself. |
not_ours.webhook_deliveries
|
integer | yes | Webhook deliveries of this visitor's events that reached the account's own systems. |
not_ours.calendar_events
|
integer | yes | Meetings of this visitor's bookings in the hosts' calendars. |
not_ours.lookup_endpoints
|
integer | yes | The account's lookup endpoints, which may have been sent this visitor's details. |
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
|
| 415 | Send the body as JSON. |
unsupported_media_type
|
| 422 | The account holds too much to answer this request in one go. |
visitor_data_too_large
|
| 429 | Too many attempts. |
rate_limited
|