Public API v1

Goal

Call the read-only BOS Public API with a tenant-scoped Sanctum token.

Who it is for

Integrators, partners.

Preconditions

• API token with tenant:{uuid} ability plus resource abilities (api:parties.read, etc.).
• Base URL: {origin}/api/v1.

Steps

1. Create a token with the required abilities (see the OpenAPI / reference doc).
2. Send Authorization: Bearer {token}.
3. Call read endpoints only — v1 has no write routes.
4. Respect rate limits and module gates (e.g. CRM routes need the crm module).

Result

You can integrate read models without using the interactive UI.

Related

• OpenAPI specification
• Full narrative reference: public-api-reference