REST API
Accounts & Users

Accounts and users

All routes use the /api/v1 base path. Except where noted, they require an access token. Organisation settings and user management are owner-only.

Current profile

MethodPathAccessPurpose
GET/accounts/meAuthenticatedRead the current user, active store, and available stores.
PATCH/accounts/meAuthenticatedUpdate profile fields such as name, email, occupation, or password.
GET/accounts/organisationOwnerRead organisation details.
PATCH/accounts/organisationOwnerUpdate organisation details and supported integration settings.

Store and user management

MethodPathAccessPurpose
POST/accounts/switch-storeAuthenticatedSelect a store and receive a new token pair for that store context.
GET/accounts/usersOwnerList users in the organisation.
POST/accounts/usersOwnerCreate a user; onboarding credentials may be sent through configured messaging.
DELETE/accounts/users/{id}OwnerDeactivate a user.

Example store switch:

curl -X POST "$ZIADA_API/accounts/switch-store" \
  -H "Authorization: Bearer $ZIADA_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"store_id":"<store-uuid>"}'

Use the token returned by the switch operation for subsequent calls. Store context is carried in the token rather than passed as a query parameter.

Service balances

MethodPathAccessPurpose
GET/accounts/ai-creditsAuthenticatedRead the organisation's AI credit usage.
GET/accounts/sms-balanceAuthenticatedRead SMS credit balance information.

See authentication for login and token flows. For exact accepted profile and organisation fields, consult the API-owned accounts route reference (opens in a new tab).