GET
/
customers
curl --request GET \
  --url https://api.onepay.la/v1/customers \
  --header 'Authorization: Bearer <token>'
{
   "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 los detalles de un cliente específico.

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

id
string

Identificador único del cliente en formato UUID

name
string

Nombre del cliente

email
string

Correo electrónico del cliente

phone
string

Número de teléfono del cliente

document_number
string

Número de documento de identidad del cliente

document_type
string

Tipo de documento de identidad del cliente (ej. DNI, RUC, CE)

created_at
date

Fecha y hora de creación del cliente

{
   "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
}

Was this page helpful?