Skip to main content

Request IDs

Every request to the Rewind Public API is assigned a unique request ID. Include it when reporting a problem so support can quickly locate your request.

What are Request IDs?​

Request IDs are unique identifiers automatically generated for each API request. They:

  • Uniquely identify each API request
  • Can be quoted when contacting support so we can locate your request

Where to Find Request IDs​

In Error Responses​

Request IDs are included in all error responses:

{
  "title": "Unauthenticated",
  "status": 401,
  "request_id": "ec91108f-f004-4694-8eb5-472aeb23f1f4",
  "instance": "/api/v1/accounts"
}

In Response Headers​

For successful requests, the request ID is available in the response headers:

curl -I "https://developer.rewind.com/api/v1/accounts" \
  -H "X-API-Key: YOUR_API_KEY"

# Response includes:
# X-Request-ID: ec91108f-f004-4694-8eb5-472aeb23f1f4

Using Request IDs For Support Requests​

When contacting support, always include the request ID:

Subject: API Error - Account Not Found

Hi Support Team,

I'm experiencing an issue with the API where I'm getting a 404 error 
when trying to access account acc_1234567890abcdef.

Request ID: ec91108f-f004-4694-8eb5-472aeb23f1f4
Timestamp: 2024-12-01T10:30:00Z
Endpoint: GET /api/v1/accounts/acc_1234567890abcdef

Please help me understand why this account is not accessible.

Request ID Format​

Request IDs follow the standard UUID v4 format:

  • Pattern: 8-4-4-4-12 hexadecimal digits separated by hyphens
  • Length: 36 characters (32 hex digits + 4 hyphens)
  • Example: ec91108f-f004-4694-8eb5-472aeb23f1f4
note

Request IDs are opaque tokens. Don't attempt to decode or parse them for business logic.

Troubleshooting with Request IDs​

Common Issues​

Missing Request IDs​

If you're not seeing request IDs in responses:

  1. Check both X-Request-ID and x-request-id headers
  2. Verify your HTTP client preserves response headers
  3. For error responses, check the request_id field in the JSON body

Inconsistent Request IDs​

If request IDs seem inconsistent:

  1. Ensure you're extracting them from the correct location
  2. Don't modify or parse request ID values
  3. Use them as opaque tokens for correlation only

Support Escalation Template​

Subject: API Issue - Request ID: ec91108f-f004-4694-8eb5-472aeb23f1f4

Request Details:
- Request ID: ec91108f-f004-4694-8eb5-472aeb23f1f4
- Timestamp: 2024-12-01T10:30:00Z
- Endpoint: GET /api/v1/accounts
- Expected behavior: [Describe expected result]
- Actual behavior: [Describe what happened]
- Error message (if any): [Include full error response]

Additional Context:
- API Key (last 4 chars): ...xyz9
- Organization: [Your organization name]
- Frequency: [One-time or recurring issue]

Request IDs are your key to effective debugging and quick issue resolution. Always include them in your logs, error reports, and support requests to ensure the fastest possible resolution of any API-related issues.