← Tools Reference

Envoy

Envoy integration (Productivity, Security). Imported from open-connector.

API key8 toolshttps://api.envoy.com
GET
envoy_list_locations
List Envoy locations with optional filters and pagination.

/rest/v1/locations

8 parameters
ParamTypeRequiredDescription
idsarrayoptionalEnvoy IDs to fetch in one list request.
pageintegeroptionalThe page number for pagination.
perPageintegeroptionalThe number of records to return per page.
orderstringoptionalThe sort direction.
createdAtAfterstringoptionalReturn locations created at or after this UTC timestamp.
createdAtBeforestringoptionalReturn locations created at or before this UTC timestamp.
enabledbooleanoptionalWhether to return active or inactive locations.
sortstringoptionalThe location field to sort by.
GET
envoy_get_location
Fetch one Envoy location by ID.

/rest/v1/locations/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Envoy resource ID.
GET
envoy_list_employees
List Envoy employees with optional search filters and pagination.

/v1/employees

7 parameters
ParamTypeRequiredDescription
idsarrayoptionalEnvoy IDs to fetch in one list request.
pageintegeroptionalThe page number for pagination.
perPageintegeroptionalThe number of records to return per page.
orderstringoptionalThe sort direction.
namestringoptionalThe employee full name search string. Envoy supports partial matches.
emailstringoptionalThe employee email search string. Envoy supports partial matches.
sortstringoptionalThe employee field to sort by.
GET
envoy_get_employee
Fetch one Envoy employee by ID.

/v1/employees/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Envoy resource ID.
GET
envoy_list_flows
List Envoy sign-in flows with optional filters and pagination.

/v1/flows

9 parameters
ParamTypeRequiredDescription
idsarrayoptionalEnvoy IDs to fetch in one list request.
pageintegeroptionalThe page number for pagination.
perPageintegeroptionalThe number of records to return per page.
orderstringoptionalThe sort direction.
locationIdsarrayoptionalEnvoy IDs to fetch in one list request.
enabledbooleanoptionalWhether to return only enabled or disabled flows.
namestringoptionalThe flow name search string.
typestringoptionalThe flow type.
sortstringoptionalThe flow field to sort by.
GET
envoy_get_flow
Fetch one Envoy sign-in flow by ID.

/v1/flows/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Envoy resource ID.
GET
envoy_list_invites
List Envoy invites with optional filters and pagination.

/v1/invites

12 parameters
ParamTypeRequiredDescription
idsarrayoptionalEnvoy IDs to fetch in one list request.
pageintegeroptionalThe page number for pagination.
perPageintegeroptionalThe number of records to return per page.
orderstringoptionalThe sort direction.
locationIdsarrayoptionalEnvoy IDs to fetch in one list request.
expectedArrivalAtBeforestringoptionalReturn invites expected before this UTC timestamp.
expectedArrivalAtAfterstringoptionalReturn invites expected after this UTC timestamp.
hostEmailstringoptionalThe host email address used to filter invites.
inviteeEmailstringoptionalThe invitee email address used to filter invites.
typestringoptionalThe invite type.
approvalStatusstringoptionalThe invite approval status.
sortstringoptionalThe invite field to sort by.
GET
envoy_get_invite
Fetch one Envoy invite by ID.

/v1/invites/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Envoy resource ID.