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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids

array of objects

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

enum

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

Allowed:

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

enum

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

Allowed:

order

string

enum

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

Allowed:

Response

default[Flow!]!