Correlation IDs

Correlation IDs (also known as Request IDs) are unique identifiers assigned to each API request. They help track requests through the system and are essential for debugging and support.

How Correlation IDs Work

Every API request and response includes a correlation ID in the header Correlation-ID. This ID uniquely identifies the request and can be used to trace the request's path through our systems.

Request Header

You can provide your own correlation ID by including it in the request header:

Correlation-ID: your-unique-identifier

The provided ID must be a valid GUID. If you don't provide a correlation ID or the given ID is not valid, the API will automatically generate one for you. The header is case-insensitive.

Response Header

Every API response includes the correlation ID in the response headers:

Correlation-ID: 550e8400e29b41d4a716446655440000

Getting Support

When contacting our support team via the shared Slack channel about an API issue, include the correlation ID from the response headers. This allows us to quickly locate your request in our logs and provide faster assistance.