Request IDs

Every API v3 response includes a unique request identifier for troubleshooting and log correlation.

Response header

The identifier is returned in the Request-Id response header for successful requests and errors, including authentication errors:

Request-Id: req_1d352b4e6502b1edda090f4b210a8cfc

Request IDs begin with req_ and identify one HTTP request. Retrying the same operation produces a new request ID, even when an idempotent retry replays an earlier resource response.

Log request IDs

Integrations should record the following when a request fails:

• The Request-Id response header.
• The HTTP method and endpoint path.
• The response status and error.code.
• The integration's own operation identifier or idempotency key, when applicable.

Do not record or send the API key when reporting a problem.