User ID Types

There are two kinds of user ids you will be working with when using the Enterprise API:

ID Type Description

Enterprise User ID This ID will be provided you to you by your account manager. You will have a unique id for every user of the Enterprise Dashboard. Each Enterprise User ID will also have a unique API key associated with it. This is the User ID you must use for all authentication when making API requests.

The Enterprise User ID / API Key combination will be valid for any Effective User ID as long as that user is part of your Enterprise Organization.

Effective User ID This ID will indicate the user whose Scheduling account you want to affect with your API request. For example, if you have three accounts within your Enterprise they might have user ids of 100, 105, and 110. If you wanted to add a new calendar to the first one you would use 100 as your Effective User ID in the API request:

POST /api/enterprise/v1/users/100/calendars

Not all API endpoints use Effective User IDs, however, all endpoints that are part of the Acuity Public API will require one.

ID Type	Description
Enterprise User ID	This ID will be provided you to you by your account manager. You will have a unique id for every user of the Enterprise Dashboard. Each Enterprise User ID will also have a unique API key associated with it. This is the User ID you must use for all authentication when making API requests. The Enterprise User ID / API Key combination will be valid for any Effective User ID as long as that user is part of your Enterprise Organization.
Effective User ID	This ID will indicate the user whose Scheduling account you want to affect with your API request. For example, if you have three accounts within your Enterprise they might have user ids of 100, 105, and 110. If you wanted to add a new calendar to the first one you would use `100` as your Effective User ID in the API request: `POST /api/enterprise/v1/users/100/calendars` Not all API endpoints use Effective User IDs, however, all endpoints that are part of the Acuity Public API will require one.