Connectors Reference
An Envoy connector that allows you to be able to connect your Envoy account (our REST API endpoints) to any other connectors. An example would be to create bulk invites in Envoy with details from a Microsoft Excel Online spreadsheet.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
getblockListFilters ([Optional]integer filter[company], [Optional]string Content-Type) |
Get blocklist filters |
|
addBlockListFilter ([Optional]addBlockListFilterParameterBody body) |
Add blocklist filter |
|
Get list of employees |
|
|
Get company info |
|
|
Get locations |
|
|
Get flows |
|
|
Get invites |
|
|
addInvite ([Optional]string Content-Type, [Optional]addInviteParameterBody body) |
Create Invites |
|
getEntryInfoByID (string entry_id, [Optional]integer filter[location], [Optional]string Accept) |
Get one Entry |
|
Get one Invite |
|
|
Update one Invite |
|
Name |
Summary |
|
Invite-Created Trigger |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get blocklist filters
Description: GET request to retrieve block list filters.
Syntax:
Envoy.getblockListFilters ([Optional]integer filter[company], [Optional]string Content-Type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
filter[company] |
integer (filter[company]) |
filter[company] |
False |
|
|
Content-Type |
string (Content-Type) |
Content-Type |
False |
Returns:
Type:getblockListFiltersResponse
Summary: Add blocklist filter
Description: POST request to add a blocklist filter
Syntax:
Envoy.addBlockListFilter ([Optional]addBlockListFilterParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
addBlockListFilterParameterBody
|
|
False |
Returns:
Type:addBlockListFilterResponse
Summary: Get list of employees
Description: GET request to retrieve the employees list
Syntax:
Envoy.getEmployee ()
Returns:
Type:getEmployeeResponse
Summary: Get company info
Description: Retrieve information around the company (GET)
Syntax:
Envoy.getCompanyInfo ([Optional]string Accept)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Accept |
string (Accept) |
Accept |
False |
Returns:
Summary: Get locations
Description: GET request for retrieving Locations
Syntax:
Envoy.getLocationInfo ([Optional]string Accept)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Accept |
string (Accept) |
Accept |
False |
Returns:
Summary: Get flows
Description: GET request to retrieve information around the flows for your location.
Syntax:
Envoy.getFlowsInfo ([Optional]integer filter[location])
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
filter[location] |
integer (filter[location]) |
filter[location] |
False |
Returns:
Type:getFlowsInfoResponse
Summary: Get invites
Description: GET request to retrieve Invite information based on filtering.
Syntax:
Envoy.getInviteInfo ([Optional]integer filter[location], [Optional]string filter[date], [Optional]string Accept)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
filter[location] |
integer (filter[location]) |
filter[location] |
False |
|
|
filter[date] |
string (filter[date]) |
filter[date] |
False |
|
|
Accept |
string (Accept) |
Accept |
False |
Returns:
Summary: Create Invites
Description: This is the POST request to create an invite
Syntax:
Envoy.addInvite ([Optional]string Content-Type, [Optional]addInviteParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Content-Type) |
Content-Type |
False |
|
|
body |
|
|
False |
Returns:
Type:addInviteResponse
Summary: Get one Entry
Description: GET request to retrieve information about a single Entry.
Syntax:
Envoy.getEntryInfoByID (string entry_id, [Optional]integer filter[location], [Optional]string Accept)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
entry_id |
string (entry_id) |
entry_id |
True |
|
|
filter[location] |
integer (filter[location]) |
filter[location] |
False |
|
|
Accept |
string (Accept) |
Accept |
False |
Returns:
Summary: Get one Invite
Description: GET request to retrieve information about a single Invite.
Syntax:
Envoy.getInviteByID (string invite_id, [Optional]string Accept)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
invite_id |
string (invite_id) |
invite_id |
True |
|
|
Accept |
string (Accept) |
Accept |
False |
Returns:
Summary: Update one Invite
Description: PATCH request to update an Invite's information.
Syntax:
Envoy.updateInvite (string invite_id, [Optional]string Content-Type, [Optional]updateInviteParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
invite_id |
string (invite_id) |
invite_id |
True |
|
|
Content-Type |
string (Content-Type) |
Content-Type |
False |
|
|
body |
|
|
False |
Returns:
Type:updateInviteResponse
Summary: Invite-Created Trigger
Description: Trigger an action in MS Flow when an Envoy Invite is created.
Syntax:
Envoy.InviteCreated (object body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Here something ese
|
|
True |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
|
type |
string
|
type |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
aliases |
array of (AliasesItem)
|
aliases |
|
description |
string
|
description |
|
emails |
array of (string)
|
emails |
|
full-name |
string
|
full-name |
|
keyword |
string
|
keyword |
|
other-keywords |
array of (Other-keywordsItem)
|
other-keywords |
|
reason |
string
|
reason |
|
phone-numbers |
array of (Phone-numbersItem)
|
phone-numbers |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
location |
|
location |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id (location) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
|
links |
|
links |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
aliases |
array of (AliasesItem)
|
aliases |
|
description |
string
|
description |
|
emails |
array of (string)
|
emails |
|
full-name |
string
|
full-name |
|
keyword |
string
|
keyword |
|
other-keywords |
array of (Other-keywordsItem)
|
other-keywords |
|
phone-numbers |
array of (Phone-numbersItem)
|
phone-numbers |
|
photo |
|
photo |
|
reason |
string
|
reason |
|
created-by |
string
|
created-by |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: photo
Properties:
|
Name |
Type |
Summary |
|
original |
string
|
original |
|
thumb |
string
|
thumb |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
location |
|
location |
|
user |
|
user |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: user
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
|
type |
string
|
type |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
full-name |
string
|
full-name |
|
|
string
|
|
|
inviter-name |
string
|
inviter-name |
|
expected-arrival-time |
string
|
expected-arrival-time |
|
recurring-rule |
string
|
recurring-rule |
|
rrule-until |
string
|
rrule-until |
|
private-notes |
string
|
private-notes |
|
been-here-before |
boolean
|
been-here-before |
|
additional-guests |
integer(int32)
|
additional-guests |
|
skip-guest-notification |
boolean
|
skip-guest-notification |
|
agreements-status |
string
|
agreements-status |
|
locality |
|
locality |
|
flow-name |
string
|
flow-name |
|
group-name |
string
|
group-name |
|
arrived |
boolean
|
arrived |
|
approval-status |
string
|
approval-status |
|
user-data |
array of (User-dataItem)
|
user-data |
Summary:
Description: locality
Properties:
|
Name |
Type |
Summary |
|
place-id |
string
|
place-id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
field |
string
|
field |
|
value |
string
|
value |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
employee |
|
employee |
|
location |
|
location |
Summary:
Description: employee
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id (employee) |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id (location) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
|
links |
|
links |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
additional-guests |
integer(int32)
|
additional-guests |
|
approval-status |
|
approval-status |
|
|
string
|
|
|
expected-arrival-time |
string
|
expected-arrival-time |
|
expected-departure-time |
string
|
expected-departure-time |
|
full-name |
string
|
full-name |
|
guest-updated-at |
string
|
guest-updated-at |
|
is-presigned |
boolean
|
is-presigned |
|
location-info |
|
location-info |
|
private-notes |
string
|
private-notes |
|
user-data |
array of (User-dataItem)
|
user-data |
|
notify-visitor |
boolean
|
notify-visitor |
|
created-from |
string
|
created-from |
|
locality |
|
locality |
|
arrived |
boolean
|
arrived |
|
touchless-sign-in-available-time |
string
|
touchless-sign-in-available-time |
|
touchless-sign-in-presence-required |
boolean
|
touchless-sign-in-presence-required |
|
entry-signed-out-at |
string
|
entry-signed-out-at |
|
preregistration-link |
string
|
preregistration-link |
|
created-at |
string
|
created-at |
|
updated-at |
string
|
updated-at |
Summary:
Description: approval-status
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
auto_approved |
boolean
|
auto_approved |
|
report |
array of (ReportItem)
|
report |
|
reviewer_id |
string
|
reviewer_id |
|
reviewer_name |
string
|
reviewer_name |
|
review_note |
string
|
review_note |
|
reviewed_at |
string
|
reviewed_at |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
result |
string
|
result |
|
source |
string
|
source |
|
blacklistReportUUID |
string
|
blacklistReportUUID |
|
reason |
string
|
reason |
|
messages |
|
messages |
Summary:
Description: messages
Properties:
|
Name |
Type |
Summary |
|
failure |
|
failure |
Summary:
Description: failure
Properties:
|
Name |
Type |
Summary |
|
text |
string
|
text |
|
header |
string
|
header |
Summary:
Description: location-info
Properties:
|
Name |
Type |
Summary |
|
address |
string
|
address |
|
id |
integer(int32)
|
id |
|
name |
string
|
name |
|
logo_url |
string
|
logo_url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
field |
string
|
field |
|
value |
string
|
value |
Summary:
Description: locality
Properties:
|
Name |
Type |
Summary |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
attendee |
|
attendee |
|
creator |
|
creator |
|
employee |
|
employee |
|
entry |
|
entry |
|
flow |
|
flow |
|
location |
|
location |
|
platform-jobs |
|
platform-jobs |
Summary:
Description: attendee
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: creator
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: employee
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
|
data |
|
data |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: entry
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
|
data |
string
|
data |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: flow
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
|
data |
|
data |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
|
data |
|
data |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: platform-jobs
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DataItem)
|
data |
|
meta |
|
meta |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
|
links |
|
links |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
aliases |
array of (AliasesItem)
|
aliases |
|
description |
string
|
description |
|
emails |
array of (string)
|
emails |
|
full-name |
string
|
full-name |
|
keyword |
string
|
keyword |
|
other-keywords |
array of (string)
|
other-keywords |
|
phone-numbers |
array of (Phone-numbersItem)
|
phone-numbers |
|
photo |
|
photo |
|
reason |
string
|
reason |
|
image-url |
string
|
image-url |
|
external-id |
string
|
external-id |
|
created-by |
string
|
created-by |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: photo
Properties:
|
Name |
Type |
Summary |
|
original |
string
|
original |
|
thumb |
string
|
thumb |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
location |
|
location |
|
user |
|
user |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: user
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: meta
Properties:
|
Name |
Type |
Summary |
|
total |
integer(int32)
|
total |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
meta |
|
meta |
|
data |
array of (DataItem)
|
data |
|
links |
|
links |
Summary:
Description: meta
Properties:
|
Name |
Type |
Summary |
|
total |
integer(int32)
|
total |
|
limit |
integer(int32)
|
limit |
|
offset |
integer(int32)
|
offset |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
name |
|
plan-intent |
string
|
plan-intent |
|
buy-intent |
boolean
|
buy-intent |
|
call-enabled |
boolean
|
call-enabled |
|
appletv-enabled |
boolean
|
appletv-enabled |
|
saml-connected |
boolean
|
saml-connected |
|
active |
boolean
|
active |
|
employees-sync-state |
string
|
employees-sync-state |
|
employees-sync-provider |
string
|
employees-sync-provider |
|
employees-last-sync-at |
string
|
employees-last-sync-at |
|
created-at |
string
|
created-at |
|
updated-at |
string
|
updated-at |
|
onboarding-status |
string
|
onboarding-status |
|
onboarding-locations-count |
string
|
onboarding-locations-count |
|
is-beta |
boolean
|
is-beta |
|
adhoc-plugins |
array of (Adhoc-pluginsItem)
|
adhoc-plugins |
|
cached-locations-quantity |
integer(int32)
|
cached-locations-quantity |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
subscription |
|
subscription |
|
deliveries-subscription |
|
deliveries-subscription |
|
contracts |
|
contracts |
|
administrators |
|
administrators |
|
locations |
|
locations |
|
saml |
|
saml |
Summary:
Description: subscription
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: deliveries-subscription
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: contracts
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: administrators
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: locations
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: saml
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
first |
string
|
first |
|
last |
string
|
last |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DataItem)
|
data |
|
meta |
|
meta |
|
links |
|
links |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
|
links |
|
links |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
cc-employee |
boolean
|
cc-employee |
|
company-id |
integer(int32)
|
company-id |
|
deleted |
boolean
|
deleted |
|
do-not-sync |
boolean
|
do-not-sync |
|
|
string
|
|
|
hide-from-host-list |
boolean
|
hide-from-host-list |
|
manually-added |
boolean
|
manually-added |
|
manually-added-location-present |
boolean
|
manually-added-location-present |
|
name |
string
|
name |
|
phone-number |
string
|
phone-number |
|
created-at |
string
|
created-at |
|
deleted-at |
string
|
deleted-at |
|
updated-at |
string
|
updated-at |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
company |
|
company |
|
user |
|
user |
|
assistants |
|
assistants |
|
bosses |
|
bosses |
|
employee-locations |
|
employee-locations |
|
locations |
|
locations |
Summary:
Description: company
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: user
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: assistants
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: bosses
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: employee-locations
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: locations
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: meta
Properties:
|
Name |
Type |
Summary |
|
total |
integer(int32)
|
total |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
first |
string
|
first |
|
last |
string
|
last |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
|
links |
|
links |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
full-name |
string
|
full-name |
|
|
string
|
|
|
host |
string
|
host |
|
host-email |
string
|
host-email |
|
private-notes |
string
|
private-notes |
|
signed-in-at |
string
|
signed-in-at |
|
device-session-uuid |
string
|
device-session-uuid |
|
signed-in-via |
string
|
signed-in-via |
|
signed-in-by |
string
|
signed-in-by |
|
signed-out-via |
string
|
signed-out-via |
|
signed-out-by |
string
|
signed-out-by |
|
thumbnails |
|
thumbnails |
|
flow-name |
string
|
flow-name |
|
original-nda-sign-date |
string
|
original-nda-sign-date |
|
id-check-status |
string
|
id-check-status |
|
is-delivery |
boolean
|
is-delivery |
|
agreement-refused |
boolean
|
agreement-refused |
|
pov-key |
string
|
pov-key |
|
user-data |
array of (User-dataItem)
|
user-data |
|
sms-status |
string
|
sms-status |
|
approval-status |
string
|
approval-status |
|
push-status |
string
|
push-status |
|
email-status |
string
|
email-status |
|
slack-status |
string
|
slack-status |
|
hipchat-status |
string
|
hipchat-status |
Summary:
Description: thumbnails
Properties:
|
Name |
Type |
Summary |
|
large |
string
|
large |
|
small |
string
|
small |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
field |
string
|
field |
|
value |
string
|
value |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
location |
|
location |
|
employee |
|
employee |
|
invite |
|
invite |
|
flow |
|
flow |
|
previous-entries |
|
previous-entries |
|
platform-jobs |
|
platform-jobs |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: employee
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: invite
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: flow
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: previous-entries
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
related |
string
|
related |
Summary:
Description: platform-jobs
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
related |
string
|
related |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DataItem)
|
data |
|
meta |
|
meta |
|
links |
|
links |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
|
links |
|
links |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
additional-guests |
boolean
|
additional-guests |
|
auto-sign-out-minutes |
string
|
auto-sign-out-minutes |
|
auto-sign-out-at-midnight |
boolean
|
auto-sign-out-at-midnight |
|
badge-enabled |
boolean
|
badge-enabled |
|
custom-translations |
|
custom-translations |
|
enabled |
boolean
|
enabled |
|
id-check |
boolean
|
id-check |
|
ipad-localized-names |
array of (Ipad-localized-namesItem)
|
ipad-localized-names |
|
name |
string
|
name |
|
position |
integer(int32)
|
position |
|
use-existing-photo |
boolean
|
use-existing-photo |
|
created-at |
string
|
created-at |
|
updated-at |
string
|
updated-at |
Summary:
Description: custom-translations
Properties:
|
Name |
Type |
Summary |
|
name |
|
name |
Summary:
Description: name
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
language-code |
string
|
language-code |
|
region-code |
string
|
region-code |
|
display-name |
string
|
display-name |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
agreement-page |
|
agreement-page |
|
badge |
|
badge |
|
location |
|
location |
|
photo-page |
|
photo-page |
|
sign-in-field-page |
|
sign-in-field-page |
|
summary-page |
|
summary-page |
Summary:
Description: agreement-page
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: badge
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: photo-page
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: sign-in-field-page
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: summary-page
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: meta
Properties:
|
Name |
Type |
Summary |
|
total |
integer(int32)
|
total |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
first |
string
|
first |
|
last |
string
|
last |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
|
included |
array of (IncludedItem)
|
included |
|
links |
|
links |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
full-name |
string
|
full-name |
|
|
string
|
|
|
inviter-name |
string
|
inviter-name |
|
expected-arrival-time |
string
|
expected-arrival-time |
|
private-notes |
string
|
private-notes |
|
arrived |
boolean
|
arrived |
|
been-here-before |
boolean
|
been-here-before |
|
flow-name |
string
|
flow-name |
|
flow-id |
integer(int32)
|
flow-id |
|
user-data |
array of (User-dataItem)
|
user-data |
|
additional-guests |
integer(int32)
|
additional-guests |
|
guest-updated-at |
string
|
guest-updated-at |
|
nda |
string
|
nda |
|
nda-available |
boolean
|
nda-available |
|
original-nda-sign-date |
string
|
original-nda-sign-date |
|
secret-token |
string
|
secret-token |
|
approval-status |
string
|
approval-status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
field |
string
|
field |
|
value |
string
|
value |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
entry |
|
entry |
|
location |
|
location |
|
flow |
|
flow |
|
employee |
|
employee |
|
creator |
|
creator |
Summary:
Description: entry
Properties:
|
Name |
Type |
Summary |
|
data |
string
|
data |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
Summary:
Description: flow
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: employee
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: creator
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
full-name |
string
|
full-name |
|
|
string
|
|
|
phone-number |
string
|
phone-number |
|
avatar |
string
|
avatar |
|
created-at |
string
|
created-at |
|
email-enabled |
boolean
|
email-enabled |
|
sms-enabled |
boolean
|
sms-enabled |
|
call-enabled |
string
|
call-enabled |
|
slack-enabled |
boolean
|
slack-enabled |
|
hipchat-enabled |
boolean
|
hipchat-enabled |
|
push-enabled |
boolean
|
push-enabled |
|
invite-push-enabled |
boolean
|
invite-push-enabled |
|
has-profile |
boolean
|
has-profile |
|
intercom-identity-hash |
string
|
intercom-identity-hash |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
location-roles |
|
location-roles |
|
company-roles |
|
company-roles |
|
emails |
|
emails |
Summary:
Description: location-roles
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
related |
string
|
related |
Summary:
Description: company-roles
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
related |
string
|
related |
Summary:
Description: emails
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
|
included |
array of (IncludedItem)
|
included |
|
links |
|
links |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
full-name |
string
|
full-name |
|
|
string
|
|
|
inviter-name |
string
|
inviter-name |
|
expected-arrival-time |
string
|
expected-arrival-time |
|
private-notes |
string
|
private-notes |
|
arrived |
boolean
|
arrived |
|
been-here-before |
boolean
|
been-here-before |
|
flow-name |
string
|
flow-name |
|
flow-id |
integer(int32)
|
flow-id |
|
user-data |
array of (User-dataItem)
|
user-data |
|
additional-guests |
integer(int32)
|
additional-guests |
|
guest-updated-at |
string
|
guest-updated-at |
|
nda |
string
|
nda |
|
nda-available |
boolean
|
nda-available |
|
original-nda-sign-date |
string
|
original-nda-sign-date |
|
secret-token |
string
|
secret-token |
|
approval-status |
string
|
approval-status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
field |
string
|
field |
|
value |
string
|
value |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
entry |
|
entry |
|
location |
|
location |
|
flow |
|
flow |
|
employee |
|
employee |
|
creator |
|
creator |
Summary:
Description: entry
Properties:
|
Name |
Type |
Summary |
|
data |
string
|
data |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
Summary:
Description: flow
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: employee
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: creator
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
full-name |
string
|
full-name |
|
|
string
|
|
|
phone-number |
string
|
phone-number |
|
avatar |
string
|
avatar |
|
created-at |
string
|
created-at |
|
email-enabled |
boolean
|
email-enabled |
|
sms-enabled |
boolean
|
sms-enabled |
|
call-enabled |
string
|
call-enabled |
|
slack-enabled |
boolean
|
slack-enabled |
|
hipchat-enabled |
boolean
|
hipchat-enabled |
|
push-enabled |
boolean
|
push-enabled |
|
invite-push-enabled |
boolean
|
invite-push-enabled |
|
has-profile |
boolean
|
has-profile |
|
intercom-identity-hash |
string
|
intercom-identity-hash |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
location-roles |
|
location-roles |
|
company-roles |
|
company-roles |
|
emails |
|
emails |
Summary:
Description: location-roles
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
related |
string
|
related |
Summary:
Description: company-roles
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
related |
string
|
related |
Summary:
Description: emails
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DataItem)
|
data |
|
meta |
|
meta |
|
links |
|
links |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
|
links |
|
links |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
address |
string
|
address |
|
address-line-one |
string
|
address-line-one |
|
address-line-two |
string
|
address-line-two |
|
auto-sign-out-at-midnight |
boolean
|
auto-sign-out-at-midnight |
|
auto-sign-out-minutes |
string
|
auto-sign-out-minutes |
|
city |
string
|
city |
|
company-name-override |
string
|
company-name-override |
|
disabled |
boolean
|
disabled |
|
employees-csv-upload-status |
string
|
employees-csv-upload-status |
|
employees-sync-message |
string
|
employees-sync-message |
|
fallback-notifications-enabled |
boolean
|
fallback-notifications-enabled |
|
pre-registration-required-enabled |
boolean
|
pre-registration-required-enabled |
|
latitude |
number(float)
|
latitude |
|
locale |
string
|
locale |
|
logo-small-url |
string
|
logo-small-url |
|
logo-thumb-url |
string
|
logo-thumb-url |
|
logo-url |
string
|
logo-url |
|
longitude |
number(float)
|
longitude |
|
name |
string
|
name |
|
printer-notifications-enabled |
boolean
|
printer-notifications-enabled |
|
multiple-languages-enabled |
boolean
|
multiple-languages-enabled |
|
enabled-locales |
array of (Enabled-localesItem)
|
enabled-locales |
|
state |
string
|
state |
|
timezone |
string
|
timezone |
|
zip |
string
|
zip |
|
average-monthly-visitors |
number(float)
|
average-monthly-visitors |
|
created-at |
string
|
created-at |
|
last-entry-at |
string
|
last-entry-at |
|
updated-at |
string
|
updated-at |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
company |
|
company |
|
device-config |
|
device-config |
|
gdpr-configuration |
|
gdpr-configuration |
|
printer |
|
printer |
|
devices |
|
devices |
|
employees |
|
employees |
|
fallback-contacts |
|
fallback-contacts |
|
flows |
|
flows |
|
locations-setup-guide-steps |
|
locations-setup-guide-steps |
|
printers |
|
printers |
|
printer-contacts |
|
printer-contacts |
Summary:
Description: company
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: device-config
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: gdpr-configuration
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: printer
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: devices
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: employees
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: fallback-contacts
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: flows
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: locations-setup-guide-steps
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: printers
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: printer-contacts
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |
|
related |
string
|
related |
Summary:
Description: meta
Properties:
|
Name |
Type |
Summary |
|
total |
integer(int32)
|
total |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
first |
string
|
first |
|
last |
string
|
last |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
|
type |
string
|
type |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
full-name |
string
|
full-name |
|
|
string
|
|
|
inviter-name |
string
|
inviter-name |
|
expected-arrival-time |
string
|
expected-arrival-time (Expected Format: 2019-03-24T21:15:00.000Z) |
|
recurring-rule |
string
|
recurring-rule |
|
rrule-until |
string
|
rrule-until |
|
private-notes |
string
|
private-notes |
|
been-here-before |
boolean
|
been-here-before |
|
additional-guests |
integer(int32)
|
additional-guests |
|
skip-guest-notification |
boolean
|
skip-guest-notification |
|
nda |
string
|
nda |
|
guest-updated-at |
string
|
guest-updated-at (Formatting: 2019-03-24T21:15:00.000Z) |
|
original-nda-sign-date |
string
|
original-nda-sign-date |
|
nda-available |
boolean
|
nda-available |
|
flow-name |
string
|
flow-name |
|
arrived |
boolean
|
arrived |
|
approval-status |
string
|
approval-status |
|
user-data |
array of (User-dataItem)
|
user-data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
field |
string
|
field |
|
value |
string
|
value |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
entry |
|
entry |
|
employee |
|
employee |
|
location |
|
location |
Summary:
Description: entry
Properties:
|
Name |
Type |
Summary |
|
data |
string
|
data |
Summary:
Description: employee
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id (employee) |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id (location) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
|
included |
array of (IncludedItem)
|
included |
|
links |
|
links |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
|
attributes |
|
attributes |
|
relationships |
|
relationships |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
agreements-status |
string
|
agreements-status |
|
full-name |
string
|
full-name |
|
|
string
|
|
|
inviter-name |
string
|
inviter-name |
|
inviter-email |
string
|
inviter-email |
|
expected-arrival-time |
string
|
expected-arrival-time |
|
private-notes |
string
|
private-notes |
|
arrived |
boolean
|
arrived |
|
been-here-before |
boolean
|
been-here-before |
|
flow-name |
string
|
flow-name |
|
flow-id |
integer(int32)
|
flow-id |
|
user-data |
array of (User-dataItem)
|
user-data |
|
additional-guests |
integer(int32)
|
additional-guests |
|
guest-updated-at |
string
|
guest-updated-at |
|
nda |
string
|
nda |
|
nda-available |
boolean
|
nda-available |
|
original-nda-sign-date |
string
|
original-nda-sign-date |
|
secret-token |
string
|
secret-token |
|
group-name |
string
|
group-name |
|
photo-url |
string
|
photo-url |
|
qr-code |
string
|
qr-code |
|
qr-code-sent-at |
string
|
qr-code-sent-at |
|
preregistration-complete |
string
|
preregistration-complete |
|
approval-status |
|
approval-status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
field |
string
|
field |
|
value |
string
|
value |
Summary:
Description: approval-status
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
auto-approved |
boolean
|
auto-approved |
|
report |
array of (ReportItem)
|
report |
|
reviewer-id |
string
|
reviewer-id |
|
reviewer-name |
string
|
reviewer-name |
|
review-note |
string
|
review-note |
|
reviewed-at |
string
|
reviewed-at |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
result |
string
|
result |
|
source |
string
|
source |
|
blacklistReportUUID |
string
|
blacklistReportUUID |
|
reason |
string
|
reason |
|
messages |
|
messages |
Summary:
Description: messages
Properties:
|
Name |
Type |
Summary |
|
failure |
|
failure |
Summary:
Description: failure
Properties:
|
Name |
Type |
Summary |
|
text |
string
|
text |
|
header |
string
|
header |
Summary:
Description: relationships
Properties:
|
Name |
Type |
Summary |
|
entry |
|
entry |
|
location |
|
location |
|
flow |
|
flow |
|
employee |
|
employee |
|
creator |
|
creator |
|
platform-jobs |
|
platform-jobs |
Summary:
Description: entry
Properties:
|
Name |
Type |
Summary |
|
data |
string
|
data |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
Summary:
Description: flow
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: employee
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: creator
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
id |
string
|
id |
Summary:
Description: platform-jobs
Properties:
|
Name |
Type |
Summary |
|
links |
|
links |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
related |
string
|
related |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
type |
string
|
type |
|
attributes |
|
attributes |
Summary:
Description: attributes
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
name |
Summary:
Description: links
Properties:
|
Name |
Type |
Summary |
|
self |
string
|
self |