Skip to main content
GET
/
v1
/
customers
List customers
curl --request GET \
  --url https://api.yuvexpay.com/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "customers": [
    {
      "customerId": "<string>",
      "name": "<string>",
      "email": "<string>",
      "document": "<string>",
      "phone": "<string>",
      "externalId": "<string>",
      "isActive": true,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  }
}

Authorizations

Authorization
string
header
required

YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.

Query Parameters

Search by name, email, or document.

isActive
enum<string>

Filter by active status.

Available options:
true,
false
page
integer
default:1

Page number for pagination.

Required range: x >= 1
limit
integer
default:20

Number of items per page (1-100).

Required range: 1 <= x <= 100

Response

Customers listed.

customers
object[]
pagination
object