Skip to main content
GET
https://api-corp.usight.com.br
/
clients
Consultar Clientes
curl --request GET \
  --url https://api-corp.usight.com.br/clients \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "codigo": "001",
      "doc_number": "12345678000190",
      "name": "Empresa Exemplo LTDA",
      "cidade": "São Paulo",
      "uf": "SP",
      "codigo_cidade": "3550308",
      "classificacao_fiscal": "simples_nacional"
    }
  ],
  "count": 1
}

Authorizations

x-api-key
string
header
required

Chave de autenticação no formato clk_live_SUA_CHAVE_AQUI. Também aceita Authorization: Bearer <chave>.

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)

limit
integer
default:100

Máximo de registros retornados (default 100, teto 1000)

Required range: x <= 1000

Response

Lista de clientes

data
object[]
count
integer
Example:

1