Envoy
App · 15 actions
Manage workplace visitors and invitations, and read employees, locations and sign-in flows.
Actions
| Action | What it does |
|---|---|
| Create entry | Create an Entry. |
| Create invite | Create an Invite. |
| Get company | Get a company. |
| Get employee | Look up an Employee by ID. |
| Get entry | Get an Entry by ID. |
| Get flow | Look up a Flow by ID. |
| Get invite | Get an Invite by ID. |
| Get location | Get a location. |
| List employees | Fetch a list of Employees. |
| List entries | Fetch a list of Entries. |
| List flows | Fetch a list of Flows. |
| List invites | Fetch a list of Invites. |
| List locations | Get locations. |
| Update entry | Update an Entry. |
| Update invite | Update an Invite. |
Create entry
Create an Entry.
Inputs
- Location
location_idtextRequired - The locationId for the location that you are creating the entry at. You can find this by using the GET locations endpoint.
- Flow
flow_idtextRequired - The sign-in flowId you want to use for the entry you are creating. You can find the flowIds by using the GET flows endpoint.
- Full name
full_nametextRequired - The name that will be associated with the entry being created.
- Email
emailtext - The email that will be associated with the entry being created.
- Signed in at
signed_in_atdate and time - If provided, this will set when the visitor signed in. Must be provided in ISO 8601 format (e.g., 2024-11-03T10:00:00Z). Defaults to current time if not provided.
- Photo base64
photo_base64text - If provided this will update the photo data attribute on the entry. Base64 encoded photo data.
- Print badge
print_badgetrue/false - If true, triggers badge printing for this entry (if a printer is configured). Defaults to false.Default:
false. - Notify host
notify_hosttrue/false - If true, sends a notification to the host employee. Defaults to false. Note: For employee screening flows, this is always treated as false regardless of the value provided.Default:
false. - Custom fields
custom_fieldslist - An array of custom field responses that correspond to the sign-in fields configured in the flow. Use this to set fields like Host (employee name), Company Name, Purpose of visit, etc.
Outputs
dataobject- Service response.
Example output
{
"data": {
"data": {
"agreementsStatus": "NOT_APPLICABLE",
"customFields": "example",
"email": "example",
"flowId": "example",
"fullName": "example",
"host": "example",
"id": "example",
"invite": "example",
"isDelivery": "example",
"locationId": "example",
"nda": "example",
"notes": "example",
"photo": "example",
"signedInAt": "2026-11-01T12:00:00Z",
"signedInBy": "example",
"signedInVia": "example",
"signedOutAt": "2026-11-01T12:00:00Z",
"signedOutBy": "example",
"signedOutVia": "example"
},
"meta": {
"messages": [],
"relationships": []
}
}
}Create invite
Create an Invite.
Inputs
- Invite id
invite_idtext - The id you would like assigned to the invite. If one is not provided we will automatically generate one.
- Expected arrival at
expected_arrival_atdate and timeRequired - The time (UTC) that the invitee is expected to arrive at.
- Expected departure at
expected_departure_atdate and time - The time (UTC) that the invitee is expected to depart at.
- Name
nametextRequired - The name of the invitee.
- Email
emailtext - The email of the invitee.
- Location
location_idtextRequired - The id for the location that you want associated with the invite. You can find locationIds by using the GET locations endpoint.
- Flow
flow_idtext - The id for the flow you want associated with the invite. You can find flowIds by using the GET flows endpoint.
- Notes
notestext - Internal notes that you want associated to the invite.
- Send email to invitee
send_email_to_inviteetrue/false - Determines if the invite is sent to the invitee when an email is provided.
- Host employee
host_employee_idtext - If you would like an internal host to be associated with the invite, include their employeeId here. EmployeeIds can be found by using the GET employees endpoint.
- Custom fields
custom_fieldslist - 'Any of the custom questions in the flow attached to the invite, along with the invitee's answers to those questions. Providing these for a new invite will pre-populate the answers. These must match exactly with the flow's sign-in fields, and one of them must be "Purpose of visit" with the flow name as the answer.'
- Photo base64
photo_base64text - Base64 encoded photo data.
- Invitation type
typetextRequired - The invitation type.One of:
VISITOR,EMPLOYEE.
Outputs
dataobject- Service response.
Example output
{
"data": {
"data": {
"approvalStatus": "PENDING",
"createdAt": "2026-11-01T12:00:00Z",
"customFields": "example",
"expectedArrivalAt": "2026-11-01T12:00:00Z",
"expectedDepartureAt": "2026-11-01T12:00:00Z",
"flowId": "example",
"host": "example",
"id": "example",
"invitee": "example",
"locationId": "example",
"notes": "example",
"photoUrl": "example",
"secretToken": "example",
"sendEmailToInvitee": "example",
"type": "example",
"updatedAt": "2026-11-01T12:00:00Z"
},
"meta": {
"messages": [],
"relationships": []
}
}
}Get company
Get a company.
Inputs
None.
Outputs
dataobject- Service response.
Example output
{
"data": {
"data": [],
"meta": {
"messages": [],
"relationships": []
}
}
}Get employee
Look up an Employee by ID.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- Service response.
Example output
{
"data": {}
}Get entry
Get an Entry by ID.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"data": {
"agreementsStatus": "NOT_APPLICABLE",
"customFields": "example",
"email": "example",
"flowId": "example",
"fullName": "example",
"host": "example",
"id": "example",
"invite": "example",
"isDelivery": "example",
"locationId": "example",
"nda": "example",
"notes": "example",
"photo": "example",
"signedInAt": "2026-11-01T12:00:00Z",
"signedInBy": "example",
"signedInVia": "example",
"signedOutAt": "2026-11-01T12:00:00Z",
"signedOutBy": "example",
"signedOutVia": "example"
},
"meta": {
"messages": [],
"relationships": []
}
}
}Get flow
Look up a Flow by ID.
Inputs
- Id
idtextRequired - The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
Outputs
dataobject- Service response.
Example output
{
"data": {}
}Get invite
Get an Invite by ID.
Inputs
- Id
idtextRequired - The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
Outputs
dataobject- Service response.
Example output
{
"data": {
"data": {
"approvalStatus": "PENDING",
"createdAt": "2026-11-01T12:00:00Z",
"customFields": "example",
"expectedArrivalAt": "2026-11-01T12:00:00Z",
"expectedDepartureAt": "2026-11-01T12:00:00Z",
"flowId": "example",
"host": "example",
"id": "example",
"invitee": "example",
"locationId": "example",
"notes": "example",
"photoUrl": "example",
"secretToken": "example",
"sendEmailToInvitee": "example",
"type": "example",
"updatedAt": "2026-11-01T12:00:00Z"
},
"meta": {
"messages": [],
"relationships": []
}
}
}Get location
Get a location.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"data": {
"address": {
"city": "example",
"country": "example",
"latitude": 1.0,
"line1": "example",
"line2": "example",
"longitude": 1.0,
"postalCode": "example",
"state": "example"
},
"capacityLimit": 1.0,
"companyId": "example",
"createdAt": "example",
"enabled": "example",
"id": "example",
"locale": "example",
"logoUrl": "example",
"name": "example",
"timezone": "example",
"updatedAt": "example"
},
"meta": {
"messages": [],
"relationships": []
}
}
}List employees
Fetch a list of Employees.
Inputs
- Ids
idstext - Ids.
- Name
nametext - The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- Email
emailtext - The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- Page
pagenumber - Page number, starting at 1.From 1 to 100000.
- Per page
per_pagenumber - Page size, up to 100.From 1 to 100.
- Sort
sorttext - Sort.One of:
NAME,EMAIL. - Order
ordertext - Order.One of:
ASC,DESC.
Outputs
dataobject- Service response.
Example output
{
"data": {}
}List entries
Fetch a list of Entries.
Inputs
- Location ids
location_idstext - Location ids.
- Signed in time after
signed_in_at_afterdate and time - A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
- Signed in time before
signed_in_at_beforedate and time - A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
- Email
emailtext - The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- Page
pagenumber - Page number, starting at 1.From 1 to 100000.
- Per page
per_pagenumber - Page size, up to 100.From 1 to 100.
- Sort
sorttext - Sort.One of:
CREATED_AT(Created at),SIGNED_IN_AT(Signed in at). - Order
ordertext - Order.One of:
ASC,DESC.
Outputs
dataobject- Service response.
Example output
{
"data": {
"data": [],
"meta": {
"messages": [],
"relationships": []
}
}
}List flows
Fetch a list of Flows.
Inputs
- Ids
idstext - Ids.
- Enabled
enabledtext - The `Boolean` scalar type represents `true` or `false`.
- Name
nametext - The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- Location ids
location_idstext - Location ids.
- Type
typetext - Type.One of:
VISITOR,EMPLOYEE. - Page
pagenumber - Page number, starting at 1.From 1 to 100000.
- Per page
per_pagenumber - Page size, up to 100.From 1 to 100.
- Sort
sorttext - Sort.One of:
NAME,CREATED_AT(Created at). - Order
ordertext - Order.One of:
ASC,DESC.
Outputs
dataobject- Service response.
Example output
{
"data": {}
}List invites
Fetch a list of Invites.
Inputs
- Location ids
location_idstext - Location ids.
- Expected arrival time before
expected_arrival_at_beforedate and time - A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
- Expected arrival time after
expected_arrival_at_afterdate and time - A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
- Created time before
created_at_beforedate and time - A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
- Created time after
created_at_afterdate and time - A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
- Host email
host_emailtext - The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- Invitee email
invitee_emailtext - The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
- Type
typetext - Type.One of:
VISITOR,EMPLOYEE. - Approval status
approval_statustext - Approval status.One of:
PENDING,APPROVED,DENIED,AWAITING_REVIEW(Awaiting review). - Page
pagenumber - Page number, starting at 1.From 1 to 100000.
- Per page
per_pagenumber - Page size, up to 100.From 1 to 100.
- Sort
sorttext - Sort.One of:
EXPECTED_ARRIVAL_AT(Expected arrival at),CREATED_AT(Created at). - Order
ordertext - Order.One of:
ASC,DESC.
Outputs
dataobject- Service response.
Example output
{
"data": {
"data": [],
"meta": {
"messages": [],
"relationships": []
}
}
}List locations
Get locations.
Inputs
- Ids
idslist - Ids.
- Created at after
created_at_aftertext - Created at after.
- Created at before
created_at_beforetext - Created at before.
- Sort
sorttext - Sort.One of:
createdAt,updatedAt. - Order
ordertext - Order.One of:
ASC,DESC. - Enabled
enabledtrue/false - Enabled.
- Page
pagenumber - Page number, starting at 1.From 1 to 100000.
- Per page
per_pagenumber - Page size, up to 100.From 1 to 100.
Outputs
dataobject- Service response.
Example output
{
"data": {
"data": [],
"meta": {
"messages": [],
"relationships": []
}
}
}Update entry
Update an Entry.
Inputs
- Id
idtextRequired - Id.
- Full name
full_nametext - If provided this will update the full name attribute on the entry.
- Email
emailtext - If provided this will update the email attribute on the entry.
- Signed out at
signed_out_atdate and time - If provided this will mark when the visitor signed out. Must be provided in ISO 8601 format (e.g., 2024-11-03T15:00:00Z).
- Location
location_idtext - If provided this will update the location associated with the entry.
- Flow
flow_idtext - If provided this will update the sign-in flow associated with the entry.
- Photo base64
photo_base64text - If provided this will update the photo data attribute on the entry. Base64 encoded photo data.
- Custom fields
custom_fieldslist - An array of custom field responses that correspond to the sign-in fields configured in the flow. Use this to update fields like Host (employee name), Company Name, Purpose of visit, etc.
Outputs
dataobject- Service response.
Example output
{
"data": {
"data": {
"agreementsStatus": "NOT_APPLICABLE",
"customFields": "example",
"email": "example",
"flowId": "example",
"fullName": "example",
"host": "example",
"id": "example",
"invite": "example",
"isDelivery": "example",
"locationId": "example",
"nda": "example",
"notes": "example",
"photo": "example",
"signedInAt": "2026-11-01T12:00:00Z",
"signedInBy": "example",
"signedInVia": "example",
"signedOutAt": "2026-11-01T12:00:00Z",
"signedOutBy": "example",
"signedOutVia": "example"
},
"meta": {
"messages": [],
"relationships": []
}
}
}Update invite
Update an Invite.
Inputs
- Id
idtextRequired - The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
- Expected arrival at
expected_arrival_atdate and time - The time (UTC) that the invitee is expected to arrive at.
- Expected departure at
expected_departure_atdate and time - The time (UTC) that the invitee is expected to depart at.
- Name
nametext - The name of the invitee.
- Email
emailtext - The email of the invitee.
- Location
location_idtext - The id for the location that you want associated with the invite. You can find locationIds by using the GET locations endpoint.
- Flow
flow_idtext - The id for the flow you want associated with the invite. You can find flowIds by using the GET flows endpoint.
- Notes
notestext - Internal notes that you want associated to the invite.
- Host employee
host_employee_idtext - If you would like an internal host to be associated with the invite, include their employeeId here. EmployeeIds can be found by using the GET employees endpoint.
- Custom fields
custom_fieldslist - 'Any of the custom questions in the flow attached to the invite, along with the invitee's answers to those questions. Providing these for a new invite will pre-populate the answers. These must match exactly with the flow's sign-in fields, and one of them must be "Purpose of visit" with the flow name as the answer.'
- Photo base64
photo_base64text - Base64 encoded photo data.
- Invitation type
typetext - The invitation type.One of:
VISITOR,EMPLOYEE.
Outputs
dataobject- Service response.
Example output
{
"data": {
"data": {
"approvalStatus": "PENDING",
"createdAt": "2026-11-01T12:00:00Z",
"customFields": "example",
"expectedArrivalAt": "2026-11-01T12:00:00Z",
"expectedDepartureAt": "2026-11-01T12:00:00Z",
"flowId": "example",
"host": "example",
"id": "example",
"invitee": "example",
"locationId": "example",
"notes": "example",
"photoUrl": "example",
"secretToken": "example",
"sendEmailToInvitee": "example",
"type": "example",
"updatedAt": "2026-11-01T12:00:00Z"
},
"meta": {
"messages": [],
"relationships": []
}
}
}