Skip to main content
Envoy
Envoy
42 actions · 2 auth methods
Preview

​
Authentication

API Key

Use an API Key for authentication. Recommended for simpler setup - provides full API access without token management.Guides: Connector Profile, Link Account

OAuth2 Password Grant

Use OAuth2 Password Grant for user-based authentication with username and password. Provides access based on user permis…Guides: Connector Profile, Link Account
Actions
|
42 actions
Action
Description
Required scopes
Get Company
Get company details
List Entries
List visitor entries (check-ins and check-outs)
Get Entry
Get details of a specific entry
List Invites
List visitor invitations
Create Invite
Create a new visitor invitation
Get Invite
Get details of a specific invitation
Update Invite
Update an existing visitor invitation
Delete Invite
Delete a visitor invitation
Check In Invite
Check in a visitor by converting an invite into an entry
Create Recurring Invite
Create a new recurring visitor invitation
Get Recurring Invite
Get details of a specific recurring invitation
Update Recurring Invite
Update an existing recurring visitor invitation
List Blocklist Entries
List all blocklist entries
Create Blocklist Entry
Create a new blocklist entry
Get Blocklist Entry
Get details of a specific blocklist entry
Update Blocklist Entry
Update an existing blocklist entry
Delete Blocklist Entry
Delete a blocklist entry
List Employees
List all employees in the workspace
Get Employee
Get details of a specific employee
List Flows
List all visitor flows
Get Flow
Get details of a specific visitor flow
List Locations
List all locations in the workspace
Get Location
Get details of a specific location
List Work Schedules
List employee work schedules
Get Work Schedule
Get details of a specific work schedule
Create Work Schedule
Create a new employee work schedule
Delete Work Schedule
Delete an employee work schedule
Check In Work Schedule
Check in to a work schedule
Check Out Work Schedule
Check out from a work schedule
List Spaces
List all spaces such as desks or rooms
Get Space
Get details of a specific space
List Desks
List all desks in the workspace
Get Desk
Get details of a specific desk
Create Desk
Create a new desk
Update Desk
Update an existing desk
Delete Desk
Delete a desk
List Reservations
List all reservations
Get Reservation
Get details of a specific reservation
Create Reservation
Create a new reservation
Check In Reservation
Check in to a reservation to start using the space
Check Out Reservation
Check out from a reservation to end usage and free the space
Cancel Reservation
Cancel a pending reservation

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/envoy/filled/png

Connector Profile

Envoy - API Key
https://stackone-logos.com/api/envoy/filled/png

Connector Profile

Envoy - OAuth2 Password Grant
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/envoy/filled/png

Link Account

Envoy - API Key
https://stackone-logos.com/api/envoy/filled/png

Link Account

Envoy - OAuth2 Password Grant
4

Use Actions

Invoke actions using one of the methods below: