Management API access

Open the actual API reference

The management API reference is available at https://YOUR_TRACKER/api/doc. It describes the endpoints, parameters and schemas supplied by your installation. Prefer that reference to examples written for a different version.

Obtain a scoped key

Find the user's API key in Settings → User. For an integration, use a dedicated user whose resource permissions match the intended work. Keep the key private.

Make a read-only first request

Authorize in the API reference using the required api-key header. Select a read-only endpoint, inspect its required parameters and execute a small request. Compare the response with the same resource in the panel.

Header: api-key: YOUR_API_KEY
Base: https://YOUR_TRACKER
Path: a read-only endpoint from your /api/doc reference

Integrate changes carefully

A successful response for a list endpoint does not authorize every write operation. Check the operation's schema, user permission and affected resource before sending a mutation. Keep request IDs and non-sensitive errors for diagnosis.

Error handling

Distinguish missing authentication, denied scope, validation errors and a temporarily unavailable server. Retry only when appropriate to the operation; repeating a create or update can have additional effects. Click tracking integrations use the separate Click API.