Consultar Clientes
curl --request GET \
--url https://api-corp.usight.com.br/clients \
--header 'x-api-key: <api-key>'import requests
url = "https://api-corp.usight.com.br/clients"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api-corp.usight.com.br/clients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-corp.usight.com.br/clients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-corp.usight.com.br/clients"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-corp.usight.com.br/clients")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-corp.usight.com.br/clients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": 3120,
"page": 1,
"limit": 50,
"total_pages": 63
}{
"error": "Cliente não cadastrado para o código '001'."
}{
"error": "Cliente não cadastrado para o código '001'."
}{
"error": "Cliente não cadastrado para o código '001'."
}Clientes
Consultar Clientes
Retorna clientes paginados (parâmetros page e limit) com suporte a filtros por código, documento ou nome. A resposta inclui count (total geral), page, limit e total_pages. Itere page de 1 até total_pages para percorrer toda a base.
GET
/
clients
Consultar Clientes
curl --request GET \
--url https://api-corp.usight.com.br/clients \
--header 'x-api-key: <api-key>'import requests
url = "https://api-corp.usight.com.br/clients"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api-corp.usight.com.br/clients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-corp.usight.com.br/clients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-corp.usight.com.br/clients"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-corp.usight.com.br/clients")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-corp.usight.com.br/clients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": 3120,
"page": 1,
"limit": 50,
"total_pages": 63
}{
"error": "Cliente não cadastrado para o código '001'."
}{
"error": "Cliente não cadastrado para o código '001'."
}{
"error": "Cliente não cadastrado para o código '001'."
}Authorizations
Apikey fornecida pelo Corp ERP. Também aceita Authorization: Bearer <apikey>.
Query Parameters
Filtra pelo código do cliente
Filtra por CPF/CNPJ (somente dígitos)
Busca parcial na razão social (case-insensitive)
Página a retornar (1-based). Use junto com limit para paginar.
Required range:
x >= 1Registros por página (default 50, máximo 100)
Required range:
1 <= x <= 100