Fetch a list of Invites

get

https://api.envoy.com/v1/invites

Finds invites based on the provided criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

locationIds

array of objects

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

locationIds

expectedArrivalAtBefore

date-time

Returns Invites that are expected before the given time.Time must be provided in UTC. .

expectedArrivalAtAfter

date-time

Returns Invites that are expected after the given time.Time must be provided in UTC. .

createdAtBefore

date-time

Returns Invites that were created before the given time. Time must be provided in UTC. Useful for incremental sync workflows.

createdAtAfter

date-time

Returns Invites that were created after the given time. Time must be provided in UTC. Useful for incremental sync workflows.

hostEmail

string

The email address of the host. Special characters and spaces should be URL-encoded.

inviteeEmail

string

The email address of the invitee. Special characters and spaces should be URL-encoded.

type

string

enum

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

Allowed:

approvalStatus

string

enum

The current status of the invite in the approval chain. Possible values are "PENDING", "APPROVED", "DENIED", and "AWAITING_REVIEW".

Allowed:

page

number

Defaults to 1

Controls which page to look at in the results. Use with perPage. The total offset (page * perPage) must not exceed 10,000. Use narrower filters (e.g., locationIds, date ranges) to reduce the result set if you need to access more records.

perPage

number

Defaults to 100

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 "CREATED_AT" or "EXPECTED_ARRIVAL_AT". Use with order.

Allowed:

order

string

enum

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

Allowed:

Response

default[Invite!]!