List Customers

Retrieve a list of customers with optional filtering.

GEThttps://api.uprails.com/customers/list

Returns a list of customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

Request Example

curl "https://api.uprails.com/customers/list?limit=10&offset=0" \
  -H "api-key: snd_YOUR_API_KEY"

Query Parameters

limitintegerdefault: 10

Number of customers to return (max: 100)

offsetintegerdefault: 0

Number of customers to skip

emailstring

Filter customers by email address

created_gtestring

Filter customers created after this timestamp (ISO 8601)

created_ltestring

Filter customers created before this timestamp (ISO 8601)

Response

200OK

{
  "data": [
    {
      "customer_id": "cus_1234567890abcdef",
      "merchant_id": "mer_xyz789",
      "email": "customer@example.com",
      "name": "John Doe",
      "phone": "+1234567890",
      "created": "2024-01-15T10:00:00Z",
      "updated": "2024-01-15T10:00:00Z"
    },
    {
      "customer_id": "cus_0987654321fedcba",
      "merchant_id": "mer_xyz789",
      "email": "jane@example.com",
      "name": "Jane Smith",
      "phone": "+0987654321",
      "created": "2024-01-14T08:00:00Z",
      "updated": "2024-01-14T08:00:00Z"
    }
  ],
  "total_count": 50,
  "has_more": true
}

Search by Email

Find a customer by their email address:

Search by Emailbash

curl "https://api.uprails.com/customers/list?email=customer@example.com" \
  -H "api-key: snd_YOUR_API_KEY"