API Users

This structure allows external systems or integrations to securely access data for specific sites.

Some features and limits mentioned on this page vary by plan. Visit our Pricing page to review the plans.

API Users Page

The API Users page is the main screen that lists API users. Workspace owners see all of them; other users see only the ones they created.

An API user is an API key together with its secret.

From this screen, you can:

• view existing API users
• create a new API user
• delete existing users

API User List

Each API user is displayed as a row in the list and includes the following information:

• API Key: The unique access key for the API user
• Authorized By: Information about the person who created the API user (name and email)
• Authorized Sites: The sites the API user can access (all sites or specific sites)
• Last Activity: The last time the API key was used

Each user also has a delete action available.

Creating an API User

Only workspace owners and admins can create and delete API users.

To create a new API user:

👉 Click the Create API User button

In the window that opens, configure the following settings:

• Authorize for all sites: When enabled, the API user can access all sites
• Authorized Sites: When disabled, access is granted only to selected sites

Site selection can be done as a multi-select.

After completing the settings:

👉 Click the Create button to create the API user

Deleting an API User

To remove an existing API user:

👉 Click the Delete User button in the relevant row

In the confirmation window that appears:

👉 If Delete is selected, the user is permanently deleted

This action cannot be undone.

Authorization Structure

API users operate in two ways based on their access scope:

• Access to all sites: The API user can access all sites within the workspace
• Access to selected sites: The API user can only operate on specified sites

This structure allows access control to be managed flexibly and securely.

Usage Scenarios

The API Users feature is typically used in the following scenarios:

• transferring data to external systems
• using monitoring data on other platforms
• automation and integration processes

To authenticate and start querying data, see the WebPixie API documentation.