Skip to main content

Overview

Retrieve detailed information about a specific customer using their unique identifier. This endpoint supports field selection, response versioning, and conditional fetching.

Base URL

Path Parameters

string
required
The unique identifier of the customer. Example: 6f7e1e7f-93d1-4fcc-b7a4-738f869615c8

Query Parameters

string
Comma-separated list of fields to include in the response. Example: fields=first_name,email,phone_number
string
API version for backwards compatibility. Default: Latest version
string
Additional related resources to include. Example: include=transactions,payment_methods

Request Examples

Response

Rate Limiting

This endpoint has a rate limit of 1000 requests per hour per API key. Rate limit information is included in the response headers:
  • X-RateLimit-Limit: Total requests allowed per hour
  • X-RateLimit-Remaining: Remaining requests in the current period
  • X-RateLimit-Reset: Time when the rate limit resets (Unix timestamp)

Common Use Cases

Returns only the customer’s basic contact information.
Returns customer data formatted according to the specified API version.

Error Responses

Best Practices

  1. Always use HTTPS for API requests
  2. Implement proper error handling
  3. Cache responses when appropriate
  4. Monitor rate limits
  5. Use field selection to minimize response payload size

Need Help?

For additional assistance: