Catalog API Documentation

Browse endpoints, parameters, and live request examples.

Request & Response Headers

Global headers used for request tracing, correlation, and observability across all API endpoints.

Why use trace headers? These headers transform debugging from a frustrating guessing game into a straightforward investigation. When something goes wrong, you can provide us with your trace ID, and we can instantly find every step your request took through our systems.

What this enables: When you include trace headers, you get capabilities that make integration smoother and debugging faster. Support cases resolve instantly when you provide your X-Trace-ID or X-Request-ID, as we can immediately see exactly what happened without back-and-forth troubleshooting. You gain end-to-end visibility by using X-Correlation-ID to track a single user action across multiple API calls, making complex workflows transparent. Performance bottlenecks become obvious as you can trace requests through our entire stack to identify slow operations. For compliance and security, these headers create an audit trail linking API activity to specific user sessions. And if something goes wrong with requests containing your trace IDs, we can proactively alert you before it impacts your users.

Best Practice: Always include a X-Trace-ID header with a unique value for each request. If your system makes multiple API calls for a single user action, use the same X-Correlation-ID across all related calls. This small effort saves hours of debugging time.

Request Headers

Optional headers you can include in your API requests for tracking and debugging.

X-Trace-ID Optional

Unique identifier for tracing requests across distributed systems. Use this to track a request as it flows through multiple services.

Example: "550e8400-e29b-41d4-a716-446655440000"
X-Correlation-ID Optional

Client-provided correlation identifier for linking related requests. Use this to group multiple API calls that are part of the same business transaction.

Example: "order-process-12345"
X-Session-ID Optional

Session identifier for analytics tracking. Use this to track all API calls within a user's session.

Example: "session-abc123"
X-User-ID Optional

External user identifier for analytics tracking. Use this to associate API calls with specific users in your system.

Example: "user-789xyz"
Authorization Required

Your API key, sent as a Bearer credential. Copy it from your dashboard and use it as-is.

Example: "Bearer YOUR_API_KEY"

Response Headers

Headers returned in API responses for tracking and correlation.

X-Request-ID Always Present

Server-generated unique request identifier. Use this when reporting issues or for debugging.

Example: "req-1234567890abcdef"

Echo Headers

The following headers are echoed back if provided in the request:

  • X-Trace-ID → Echoed if provided
  • X-Correlation-ID → Echoed if provided

Note: X-Session-ID and X-User-ID are accepted and logged but not echoed back in responses.

Usage Example

curl -X GET "https://api.example.com/api/v2/sockets" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "X-Trace-ID: 550e8400-e29b-41d4-a716-446655440000" \
-H "X-Correlation-ID: order-process-12345" \
-H "X-Session-ID: session-abc123" \
-H "X-User-ID: user-789xyz"