ESTABLISHMENT

The Establishment entity defines a business location or branch that is part of a user's organization.

⚠️

Note: All authenticated requests must include a valid bearer token in the

Authorization header:
Authorization: Bearer your-access-token You can obtain this token by authenticating with your client_id and client_secret_token at the endpoint /api/v1/auth/token. Once authenticated, use the returned token in all subsequent requests.

Key Capabilities

CRUD operations on establishments.

Search and filter establishments by location, status, or name.

Get nearby establishments based on coordinates and radius.

Use Cases

Manage multi-location businesses or franchises.

Allow customers to locate their nearest store or partner.

Group customer or transaction data by location.