Skip to main content
GET
/
v1
/
client
Buscar clientes
curl --request GET \
  --url https://sandbox.api.veepag.com/v1/client \
  --header 'apiKey: <api-key>'
{
  "items": [],
  "has_more": false,
  "limit": 20,
  "total_pages": 1,
  "page": 1,
  "total": 0,
  "query_count": 0
}

Authorizations

​
apiKey
string
header
required

API key no formato keyId.secret.

Query Parameters

​
page
integer
default:1

Page number (starting at 1)

Required range: x >= 1
Example:

1

​
limit
integer
default:20

Max items per page (1-100)

Required range: 1 <= x <= 100
Example:

20

​
sort.order
enum<string>
default:desc

Sort direction (asc|desc)

Available options:
asc,
desc
Example:

"desc"

​
sort.property
enum<string>
default:createdAt

Sort field (createdAt|lastUpdate)

Available options:
createdAt,
lastUpdate
Example:

"createdAt"

​
rangeTime.end
string<date-time>

Range end (ISO string). Used with sort.property.

Example:

"2026-06-23T23:59:59.999Z"

​
rangeTime.start
string<date-time>

Range start (ISO string). Used with sort.property.

Example:

"2026-06-01T00:00:00.000Z"

​
personalInfo
string

Search term (name/doc/email/etc)

​
id
string

Client ID

Response

Clientes paginados.

​
items
object[]
​
has_more
boolean
Example:

false

​
limit
integer
Example:

20

​
total_pages
integer
Example:

1

​
page
integer
Example:

1

​
total
integer
Example:

0

​
query_count
integer
Example:

0