Getting Started

Introduction
Authentication
Status Codes
Errors

Core APIs

Companies
- Get a companyget
Locations
- Get a locationget
- Get locationsget

Visitors and Protect API

Introduction
Employees
- Fetch a list of Employeesget
- Look up an Employee by IDget
Flows
- Fetch a list of Flowsget
- Look up a Flow by IDget
Entries
Invites
RecurringInvites
WorkSchedules

Spaces API

Introduction
Reservations
Spaces
- Get a spaceget
- Get spacesget
Desks

Visitors API (Legacy)

Introduction
Blocklists
Devices
- Retrieve devicesget
Employees
- Retrieve employeesget
- Import Employees Recordspost
Entries
Flows
- Retrieve flowsget
Invites

Webhooks

Event Types

Getting Started

Introduction
Authentication
Status Codes
Errors

Core APIs

Companies
- Get a companyget
Locations
- Get a locationget
- Get locationsget

Visitors and Protect API

Introduction
Employees
- Fetch a list of Employeesget
- Look up an Employee by IDget
Flows
- Fetch a list of Flowsget
- Look up a Flow by IDget
Entries
Invites
RecurringInvites
WorkSchedules

Spaces API

Introduction
Reservations
Spaces
- Get a spaceget
- Get spacesget
Desks

Visitors API (Legacy)

Introduction
Blocklists
Devices
- Retrieve devicesget
Employees
- Retrieve employeesget
- Import Employees Recordspost
Entries
Flows
- Retrieve flowsget
Invites

Webhooks

Event Types

Fetch a list of Flows

get https://api.envoy.com/v1/flows

Finds flows based on the provided criteria. Note that, depending on your company subscription plan, the results returned by this endpoint may be limited.

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Query Params

ids

array of strings

A comma-separated list of IDs. Allows lookup for multiple specific flows at once.

ids

enabled

boolean

Whether the flow is currently enabled for the location. A flow may be disabled and therefore will not appear as an option during visitor registration.

name

string

The name of the flow.

locationIds

array of strings

A comma-separated list of IDs. Allows lookup for multiple specific locations' flows at once.

locationIds

type

string

The type of registration the flow corresponds to. Currently, there are two possible options, "VISITOR" and "EMPLOYEE".

page

number

Defaults to 1

Controls which page to look at in the results. Use with perPage.

perPage

number

Defaults to 50

Controls how many results to show in each page of the results. Use with page.

sort

string

Controls which field should be compared to sort the results. Possible values are "NAME" or "CREATED_AT". Use with order.

order

string

Controls the sorting direction. Possible values are "ASC" and "DESC". Use with sort.

Response

Response body

object

data

array of objects

required

data*

object

string

required

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.

name

string

required

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

string

required

The type of registration the flow corresponds to. Currently, there are two types: visitor and employee.

enabled

boolean

required

The Boolean scalar type represents true or false.

locationId

string

createdAt

date-time

required

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.

updatedAt

date-time

required

meta

object

relationships

array of strings

Optional relationships to load with the relationships query param.

relationships

messages

array of strings

Optional scope information.

messages

Updated over 1 year ago

Look up an Employee by ID

Look up a Flow by ID

Did this page help you?

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.envoy.com/v1/flows?page=1&perPage=50' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

Look up an Employee by ID

Look up a Flow by ID

Did this page help you?

Getting Started
Introduction
Authentication
Status Codes
Errors

Core APIs
Companies
Get a companyget
Locations
Get locationsget
Get a locationget

Visitors and Protect API
Introduction
Employees
Look up an Employee by IDget
Fetch a list of Employeesget
Flows
Look up a Flow by IDget
Fetch a list of Flowsget
Entries
Create an Entrypost
Fetch a list of Entriesget
Update an Entrypost
Get an Entry by IDget
Invites
Check in an invitepost
Delete an Invitedelete
Update an Invitepost
Get an Invite by IDget
Create an Invitepost
Fetch a list of Invitesget
RecurringInvites
Update a RecurringInvitepost
Look up a RecurringInviteget
Create a RecurringInvitepost
WorkSchedules
Check out a WorkSchedulepost
Check in a WorkSchedulepost
Delete a WorkScheduledelete
Get a WorkScheduleget
Create WorkSchedulespost
Get WorkSchedulesget

Spaces API
Introduction
Reservations
Reservation Cancelpost
Reservation Checkoutpost
Reservation Check-inpost
Create a reservationpost
Get reservationsget
Get a reservationget
Spaces
Get spacesget
Get a spaceget
Desks
Update a Deskpatch
Delete a Deskdelete
Get a deskget
Create a Deskpost
Get desksget

Visitors API (Legacy)
Introduction
Blocklists
Update blocklistpatch
Delete a blocklistdelete
Retrieve blocklistsget
Creates blocklist rulepost
Devices
Retrieve devicesget
Employees
Import Employees Recordspost
Retrieve employeesget
Entries
Create entriespost
Retrieve entries by dateget
Update entriespatch
Retrieve an entry by idget
Flows
Retrieve flowsget
Invites
Update invitepatch
Retrieve inviteget
Create invitespost
Retrieve invites by dateget

Webhooks
Event Types

Getting Started
Introduction
Authentication
Status Codes
Errors

Core APIs
Companies
Get a companyget
Locations
Get locationsget
Get a locationget

Visitors and Protect API
Introduction
Employees
Look up an Employee by IDget
Fetch a list of Employeesget
Flows
Look up a Flow by IDget
Fetch a list of Flowsget
Entries
Create an Entrypost
Fetch a list of Entriesget
Update an Entrypost
Get an Entry by IDget
Invites
Check in an invitepost
Delete an Invitedelete
Update an Invitepost
Get an Invite by IDget
Create an Invitepost
Fetch a list of Invitesget
RecurringInvites
Update a RecurringInvitepost
Look up a RecurringInviteget
Create a RecurringInvitepost
WorkSchedules
Check out a WorkSchedulepost
Check in a WorkSchedulepost
Delete a WorkScheduledelete
Get a WorkScheduleget
Create WorkSchedulespost
Get WorkSchedulesget

Spaces API
Introduction
Reservations
Reservation Cancelpost
Reservation Checkoutpost
Reservation Check-inpost
Create a reservationpost
Get reservationsget
Get a reservationget
Spaces
Get spacesget
Get a spaceget
Desks
Update a Deskpatch
Delete a Deskdelete
Get a deskget
Create a Deskpost
Get desksget

Visitors API (Legacy)
Introduction
Blocklists
Update blocklistpatch
Delete a blocklistdelete
Retrieve blocklistsget
Creates blocklist rulepost
Devices
Retrieve devicesget
Employees
Import Employees Recordspost
Retrieve employeesget
Entries
Create entriespost
Retrieve entries by dateget
Update entriespatch
Retrieve an entry by idget
Flows
Retrieve flowsget
Invites
Update invitepatch
Retrieve inviteget
Create invitespost
Retrieve invites by dateget

Webhooks
Event Types

default[Flow!]!