Skip to main content
GET
/
customers
curl https://api.onepay.la/v1/customers?page=1&limit=20 \
  -H "Authorization: Bearer sk_test_xxx"

{
   "data":[
      {
         "id":"9da58912-101d-46f8-86c9-20a52119c0bf",
         "first_name":"John",
         "last_name":"Doe",
         "email":"john.doe@example.com",
         "phone":"+573100001020",
         "document_type":"CC",
         "document_number":"1060500333",
         "created_at":"2024-12-04T20:09:08.000000Z"
      }
   ],
   "current_page":1,
   "first_page_url":"https:\/\/api.onepay.la\/v1\/customers?page=1",
   "from":1,
   "next_page_url":null,
   "path":"https:\/\/api.onepay.la\/v1\/customers",
   "per_page":20,
   "prev_page_url":null,
   "to":4
}
Obtiene la lista de clientes registrados en tu cuenta de OnePay.

​
Query Parameters

​
page
integer
default:"1"
Número de página para paginación.
​
limit
integer
default:"20"
Cantidad de resultados por página (máximo 100).
​
email
string
Filtra clientes por correo electrónico.
​
document_number
string
Filtra clientes por número de documento.
​
phone
string
Filtra clientes por número de teléfono.
curl https://api.onepay.la/v1/customers?page=1&limit=20 \
  -H "Authorization: Bearer sk_test_xxx"

​
Response

​
current_page
number
Número de la página actual
​
first_page_url
string
URL para acceder a la primera página de resultados
​
from
number
Índice inicial del primer elemento en la página actual
​
next_page_url
string
URL para acceder a la siguiente página de resultados. Será null si es la última página
​
path
string
URL base de la API sin los parámetros de paginación
​
per_page
number
Cantidad de elementos por página
​
prev_page_url
string
URL para acceder a la página anterior. Será null si es la primera página
​
to
number
Índice final del último elemento en la página actual
​
data
array
Datos de la página actual
{
   "data":[
      {
         "id":"9da58912-101d-46f8-86c9-20a52119c0bf",
         "first_name":"John",
         "last_name":"Doe",
         "email":"john.doe@example.com",
         "phone":"+573100001020",
         "document_type":"CC",
         "document_number":"1060500333",
         "created_at":"2024-12-04T20:09:08.000000Z"
      }
   ],
   "current_page":1,
   "first_page_url":"https:\/\/api.onepay.la\/v1\/customers?page=1",
   "from":1,
   "next_page_url":null,
   "path":"https:\/\/api.onepay.la\/v1\/customers",
   "per_page":20,
   "prev_page_url":null,
   "to":4
}