Organization, Entities, and API Access

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Use the Right Admin Surface

Arcus separates organization-level controls from entity-level settings. This keeps company access, billing limits, and entity creation separate from daily operating settings like shipping, tax, users, products, and documents.

• Organization Overview: review the current plan, usage, and enabled features.
• Entities: create sandbox or production entities and deactivate or reactivate existing entities.
• Organization Users: invite people and assign them to one or more entities.
• Roles and Entity Team: tune what users can do inside an entity.
• API Keys: create personal entity-scoped tokens for scripts that act as your user.

​

Review the Organization Overview

Open Admin, then Organization. The overview shows the current plan, subscription status, feature badges, and usage against limits such as entities, users, and products.

If Arcus blocks a new entity, new user, or product expansion, check this page first. A plan limit is different from a permission issue: a permission issue usually hides or blocks an action for one user, while a plan limit affects the organization.

​

Manage Entities

An entity is a separate operating company or environment inside the same organization. Each entity has its own customers, products, inventory, accounting, documents, settings, and user memberships.

• Production: live operating data. Use this for real orders, payments, labels, inventory, and accounting.
• Sandbox: test and training data. Use this before changing a production process.
• Active: users with membership can enter the entity.
• Inactive: the entity is no longer available for normal work, but its record remains in the organization.

​

Create an Entity

Use Create Entity only when the business truly needs a separate company, separate sandbox, or separate live environment. If you only need a warehouse, store, ship-from address, or receiving location, create a location instead.

1. Open Admin, then Organization.
2. Choose Entities.
3. Select Create Entity.
4. Enter a clear entity name.
5. Enter a short uppercase entity code that operators will recognize.
6. Choose Production or Sandbox.
7. Create the entity.
8. Invite or assign the users who should access the new entity.
9. Complete the entity setup checklist before using it for live work.

​

Deactivate or Reactivate an Entity

Deactivation is an access and operating-control action. It is not a cleanup shortcut. Use it when an entity should no longer be used for normal work, such as an old sandbox, a retired division, or a duplicate entity created during setup.

• Confirm no team is actively using the entity.
• Review open orders, open POs, unpaid bills, unposted accounting work, and active integrations.
• Export or archive required reports before removing day-to-day access.
• Tell users which entity replaces it, if any.
• Reactivate only after confirming why the entity was disabled.

​

Use Personal API Keys Safely

API keys let scripts authenticate to Arcus as your user for the current entity. They are useful for controlled reporting, scheduled imports, and operational automation, but they should be handled like passwords.

Each key is entity-scoped. A key created while you are in one entity should not grant access to a different entity. The key can also be scoped to specific permissions, and Arcus will not allow you to grant a key more access than your own effective permissions.

​

Create an API Key

1. Open API Keys from the account or profile area.
2. Select New key.
3. Name the key after the script or job that will use it.
4. Choose an expiration period. Shorter is safer.
5. Select only the scopes the script needs. Avoid unrestricted keys unless there is a clear reason.
6. Create the key.
7. Copy the token immediately and store it in your secret manager.

​

API Key Safety Rules

• Use one key per script or integration job so it can be revoked without breaking unrelated work.
• Prefer scoped keys over unrestricted keys.
• Use expirations and rotate keys on a schedule.
• Revoke a key immediately if it may have been shared, copied into logs, or committed to code.
• Remove keys during offboarding or when a script is retired.
• Review last-used timestamps to find stale keys.

​

Common Blocks

• Create Entity is blocked: check your organization role and plan entity limit.
• A user cannot see a new entity: add the user to the entity from Organization Users and confirm their role.
• An entity is missing from the selector: confirm it is active and the user has an active membership.
• API Keys page is unavailable: your role may not include personal API key management or API Access may not be enabled.
• Scope cannot be selected: your user must already have that permission before a key can receive it.
• Script stopped working: check expiration, revoked status, entity context, and whether your role or scopes changed.

​

Related Articles