Fetch Customer
Retrieve details of a specific customer by their ID
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
The unique identifier of the customer.
Example: 6f7e1e7f-93d1-4fcc-b7a4-738f869615c8
Query Parameters
Comma-separated list of fields to include in the response.
Example: fields=first_name,email,phone_number
API version for backwards compatibility. Default: Latest version
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
Error Responses
Status Code | Description |
---|---|
400 | Invalid request (malformed parameters) |
401 | Authentication failed (invalid or missing API key) |
403 | Permission denied |
404 | Customer not found |
429 | Rate limit exceeded |
500 | Internal server error |
Best Practices
-
Always use HTTPS for API requests
-
Implement proper error handling
-
Cache responses when appropriate
-
Monitor rate limits
-
Use field selection to minimize response payload size
Need Help?
For additional assistance:
-
Check our API Reference
-
Contact Support