Trak Software Documentation logo

API Authentication

All API requests require authenticating with Bearer Authentication. In the Authentication header, you will need to pass the provided api key.Your HTTP client library should have built-in support for Bearer authentication, but here’s a quick example that shows how to authenticate with the --header option in curl:

curl --request GET \
--url 'https://example.trak.io/api/v1/<endpoint>' \
--header 'content-type: application/json' \
--header 'Authentication: Bearer <api_key>'

User Roles

Access to each endpoint is determined by the role of the user who generated the API key. Endpoint documentation will reference the required user role. Permissions cascade up, for example, all permissions a manager has, will also be granted to executives and admins.

Group ID User Role Description
1 Admin Access to all modules and endpoints. Configures Trak Sponsorship.
2 Executive Reports on users, access to all team member modules and endpoints.
3 Manager Access to team member modules and endpoints, Small configuration permissions.
4 Member Access to all team member modules and endpoints
5 Collaborator Access to accounts and collaborative data associated accounts assigned to them.

{primary} If a user cannot access an endpoint, the request will receive a 403 error.