> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Envoy

> How to set up the Envoy connector, plus the actions that are available.

![Envoy](https://stackone-logos.com/api/envoy/filled/svg)

v1.3.0[See changelog](https://docs.stackone.com/connectors/envoy/changelog.md)

[49 actions](#actions) · 2 auth methods

IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/envoy/guides/connector-profile/api-key.md)
>
> Use an API Key for authentication. Recommended for simpler setup - provides full API access without token management.

> [card] [OAuth2 Password Grant · Connector Profile](https://docs.stackone.com/connectors/envoy/guides/connector-profile/oauth2-password-grant.md)
>
> Use OAuth2 Password Grant for user-based authentication with username and password. Provides access based on user permis...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/envoy/guides/link-account/api-key.md)

> [card] [OAuth2 Password Grant · Link Account](https://docs.stackone.com/connectors/envoy/guides/link-account/oauth2-password-grant.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

blacklist-filters.read

blacklist-filters.write

companies.read

employees.read

entries.read

entries.write

flows.read

invites.read

invites.write

locations.read

reservations.read

reservations.write

spaces.read

spaces.write

work-schedules.read

work-schedules.write

No scopes found

49 actions

ActionDescriptionRequired scopes

Get Company`envoy_get_company`

Get company details

`companies.read`

List Entries`envoy_list_entries`

List visitor entries (check-ins and check-outs)

`entries.read`

Get Entry`envoy_get_entry`

Get details of a specific entry

`entries.read`

List Invites`envoy_list_invites`

List visitor invitations

`invites.read`

Create Invite`envoy_create_invite`

Create a new visitor invitation

`invites.write`

Get Invite`envoy_get_invite`

Get details of a specific invitation

`invites.read`

Update Invite`envoy_update_invite`

Update an existing visitor invitation

`invites.write`

Delete Invite`envoy_delete_invite`

Delete a visitor invitation

`invites.write`

Check In Invite`envoy_checkin_invite`

Check in a visitor by converting an invite into an entry

`entries.write`

Create Recurring Invite`envoy_create_recurring_invite`

Create a new recurring visitor invitation

`invites.write`

Get Recurring Invite`envoy_get_recurring_invite`

Get details of a specific recurring invitation

`invites.read`

Update Recurring Invite`envoy_update_recurring_invite`

Update an existing recurring visitor invitation

`invites.write`

List Blocklist Entries`envoy_list_blocklists`

List all blocklist entries

`blacklist-filters.read`

Create Blocklist Entry`envoy_create_blocklist`

Create a new blocklist entry

`blacklist-filters.write`

Get Blocklist Entry`envoy_get_blocklist`

Get details of a specific blocklist entry

`blacklist-filters.read`

Update Blocklist Entry`envoy_update_blocklist`

Update an existing blocklist entry

`blacklist-filters.write`

Delete Blocklist Entry`envoy_delete_blocklist`

Delete a blocklist entry

`blacklist-filters.write`

List Employees`envoy_list_employees`

List all employees in the workspace

`employees.read`

Get Employee`envoy_get_employee`

Get details of a specific employee

`employees.read`

List Flows`envoy_list_flows`

List all visitor flows

`flows.read`

Get Flow`envoy_get_flow`

Get details of a specific visitor flow

`flows.read`

List Locations`envoy_list_locations`

List all locations in the workspace

`locations.read`

Get Location`envoy_get_location`

Get details of a specific location

`locations.read`

List Work Schedules`envoy_list_work_schedules`

List employee work schedules

`work-schedules.read`

Get Work Schedule`envoy_get_work_schedule`

Get details of a specific work schedule

`work-schedules.read`

Create Work Schedule`envoy_create_work_schedule`

Create a new employee work schedule

`work-schedules.write`

Delete Work Schedule`envoy_delete_work_schedule`

Delete an employee work schedule

`work-schedules.write`

Check In Work Schedule`envoy_checkin_work_schedule`

Check in to a work schedule

`work-schedules.write`

Check Out Work Schedule`envoy_checkout_work_schedule`

Check out from a work schedule

`work-schedules.write`

List Spaces`envoy_list_spaces`

List all spaces such as desks or rooms

`spaces.read`

Get Space`envoy_get_space`

Get details of a specific space

`spaces.read`

List Desks`envoy_list_desks`

List all desks in the workspace

`spaces.read`

Get Desk`envoy_get_desk`

Get details of a specific desk

`spaces.read`

Create Desk`envoy_create_desk`

Create a new desk

`spaces.write`

Update Desk`envoy_update_desk`

Update an existing desk

`spaces.write`

Delete Desk`envoy_delete_desk`

Delete a desk

`spaces.write`

List Reservations`envoy_list_reservations`

List all reservations

`reservations.read`

Get Reservation`envoy_get_reservation`

Get details of a specific reservation

`reservations.read`

Create Reservation`envoy_create_reservation`

Create a new reservation

`reservations.write`

Check In Reservation`envoy_checkin_reservation`

Check in to a reservation to start using the space

`reservations.write`

Check Out Reservation`envoy_checkout_reservation`

Check out from a reservation to end usage and free the space

`reservations.write`

Cancel Reservation`envoy_cancel_reservation`

Cancel a pending reservation

`reservations.write`

Get Unified Credentials`envoy_unified_get_me`

Return the authenticated identity and derived auth type for the current Envoy connection.

`employees.read`

List Unified Groups`envoy_unified_list_groups`

List Envoy locations mapped to the IAM unified group schema.

`locations.read`

Get Unified Group`envoy_unified_get_group`

Retrieve a single Envoy location by id, mapped to the IAM unified group schema.

`locations.read`

List Unified Organizations`envoy_unified_list_organizations`

List the single Envoy company tenant as an IAM organization.

`companies.read`

Get Unified Organization`envoy_unified_get_organization`

Retrieve the Envoy company tenant by id.

`companies.read`

List Unified Users`envoy_unified_list_users`

List Envoy employees mapped to the IAM unified user schema.

`employees.read`

Get Unified User`envoy_unified_get_user`

Retrieve a single Envoy employee by id, mapped to the IAM unified user schema.

`employees.read`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.