Accounts (legacy)

Multiple Operators can be associated with an EVRYTHNG Platform account. Through use of the Roles API each can be given the appropriate permissions and levels of scope necessary for their role in the application.

From each Operator's perspective, they each have a unique access to each account they are associated with, and are granted an Operator API Key for each.

API Status General Availability: /accounts /accounts/:accountId /accounts/:accountId/shortDomains /accounts/:accountId/domains

AccountDocument Data Model

Filterable Fields

This resource type can be filtered using the following fields and operators.


AccountConfiguration Data Model


AccessDocument Data Model

The AccessDocument contains role and authentication information for an account.


Read All Accounts

Read an array of all accounts visible to an Operator with their API key.


Read an Account

Read an account by its ID by sending a GET request to the /accounts/:accountId endpoint.


Update an Account

Update an account with new user information or custom fields by sending an AccountDocument with only the fields to be updated. For example, the name, or imageUrl which will be displayed in the Dashboard.


Read Account Accesses

Read all available accesses to an account. This translates to the list of Operators who are listed as team members.


Read an Account Access

Read a single account access by ID.


Read all Short Domains

Read all short domains available to an account.


DomainDocument Data Model


Read all Domains