Skip to main content
GET
Consultar Clientes

Authorizations

x-api-key
string
header
required

Apikey fornecida pelo Corp ERP. Também aceita Authorization: Bearer <apikey>.

Query Parameters

codigo
string

Filtra pelo código do cliente

doc
string

Filtra por CPF/CNPJ (somente dígitos)

nome
string

Busca parcial na razão social (case-insensitive)

page
integer
default:1

Página a retornar (1-based). Use junto com limit para paginar.

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

Registros por página (default 50, máximo 100)

Required range: 1 <= x <= 100

Response

Lista de clientes

data
object[]
count
integer

Total de registros que satisfazem o filtro (todas as páginas)

Example:

3120

page
integer

Página atual

Example:

1

limit
integer

Registros por página

Example:

50

total_pages
integer

Total de páginas disponíveis

Example:

63