Managing Users

Access to an Apicbase library is managed through user connectors. A user connector is the link between a user account and either the library or a specific outlet. Rather than managing users and their access separately, you create, update, and delete user connectors to control who has access to what.

Library Users and Outlet Users

There are two types of user connector, determined by whether an outlet is specified when it is created:

• Library user (L): has access to the entire library — its recipes, ingredients, menus, and all outlets within it. Use this for staff who need broad access, such as managers or chefs.
• Outlet user (O): has access to a single outlet only. Use this for staff whose work is scoped to one location, such as a store operator or a POS integration account.

Each connector carries a role, which controls what actions the user can perform. Use the Get User Roles endpoint to retrieve the available roles for your library, filtering by type (L or O) to see only the roles relevant to the connector you are creating.

Adding a User

Use the Create User & Connector endpoint to add a user to the library.

• If no account exists for the provided email address, a new user account is created automatically.
• If an account already exists, the existing account is used and a new connector is created for it. The first_name and last_name fields will be updated if provided.

To create a library user, omit the outlet field. To create an outlet user, include the outlet ID. See Listing Outlets for how to retrieve outlet IDs.

Set send_verification_email to true to have Apicbase send the user an email to verify their account and set their password. This is recommended when creating new accounts.

Listing Users and Their Access

Use the Get User Connectors endpoint to retrieve all user connectors in the library. You can filter by:

• type — L for library users, O for outlet users
• email — partial, case-insensitive match
• role_id — filter by a specific role
• outlet_id — filter by a specific outlet

This is the right endpoint for building user management UIs or auditing who has access to which outlets.

Reassigning an Outlet User to a Different Outlet

Use the Update User Connector endpoint to move an outlet user from one outlet to another. Pass the new outlet's ID in the outlet field. All other fields are optional and only updated if included in the request.

The same endpoint can be used to change a user's role or update their personal details.

Removing a User

Use the Delete User Connector endpoint to revoke a user's access to the library or outlet. This removes the connector only, the user account itself is not deleted. If the user has connectors in other libraries, those are unaffected.