curl --request GET \
--url https://api.gestio.com.br/v2/cliente \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gestio.com.br/v2/cliente"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gestio.com.br/v2/cliente', 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.gestio.com.br/v2/cliente",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.gestio.com.br/v2/cliente"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.gestio.com.br/v2/cliente")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gestio.com.br/v2/cliente")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"nomeComercial": "Comercial Alfa",
"codigoDoCliente": 1023,
"razaoSocial": "Comercial Alfa Distribuidora Ltda",
"natureza": "J",
"seuCodigo": "<string>",
"cnpjcpf": "<string>",
"cnpj": "12345678000199",
"cpf": "12345678909",
"inscricaoEstadual": "<string>",
"inscricaoMunicipal": "<string>",
"indicadorContribuinte": "<string>",
"codigoDoTipoDeCliente": 123,
"descricaoDoTipoDeCliente": "<string>",
"codigoDoGrupoDeCliente": 123,
"codigoDaClassificacaoAuxiliar": 123,
"descricaoDoGrupoDeCliente": "<string>",
"codigoDoSegmento": "<string>",
"idRamoDeAtividade": 123,
"descricaoDoSegmento": "<string>",
"codigoDoVendedor": 123,
"descricaoDoVendedor": "<string>",
"codigoDaCategoria": 123,
"codigoDaSituacaoFinanceira": 123,
"descricaoDaCategoria": "<string>",
"descricaoDaSituacaoFinanceira": "<string>",
"endereco": {
"cep": "01311000",
"logradouro": "Av. Paulista",
"numero": "1578",
"complemento": "Conjunto 41",
"bairro": "Bela Vista",
"cidade": "São Paulo",
"uf": "SP",
"codigoDoMunicipio": "3550308"
},
"telefone": "(11) 4002-8922",
"site": "https://www.suaempresa.com.br",
"email": "[email protected]",
"receberEmailBoleto": true,
"paisExterior": true,
"codigoDoPais": 123,
"idExterior": "<string>",
"observacao": "<string>",
"observacaoFinanceiro": "<string>",
"textoLivre": "<string>",
"codigoDoRegimeTributario": 123,
"descricaoDoRegimeTributario": "<string>",
"contatoFinanceiro": "<string>",
"emailContatoFinanceiro": "<string>",
"telefoneFinanceiro": "<string>",
"emailsFinanceiro": [
"<string>"
],
"contatoFaturamento": "<string>",
"emailContatoFaturamento": "<string>",
"telefoneFaturamento": "<string>",
"aliquotaISSRetidoFaturamento": 123,
"dataDeCadastro": "2023-11-07T05:31:56Z",
"ativo": true,
"podeAtivar": true,
"podeDesativar": true,
"idClienteWS": "<string>",
"ultimaAtualizacao": "<string>",
"contatos": [
{
"codigoDoCliente": 1023,
"seqContato": 1,
"nomeDoContato": "Ana Beatriz Ferreira",
"nomeAbreviado": "Ana Ferreira",
"departamento": "Financeiro",
"telefone": "(11) 4002-8922",
"celular": "(11) 98877-6655",
"email": "[email protected]",
"observacao": "<string>",
"ativo": true
}
],
"podeEditar": true,
"nomeComercialFmt": "<string>"
}
}Obter Clientes
Retorna a lista de Clientes cadastrados. Se cnpjcpf for informado, retorna um único Cliente correspondente (ou null). Se idws for informado, retorna um único Cliente pelo identificador externo (ou null). Se nenhum dos dois for informado, retorna a lista completa filtrada por período de atualização (dataInferior/dataSuperior), limitada a 500 registros (exceto para a empresa AfixGraf, que não tem limite).
curl --request GET \
--url https://api.gestio.com.br/v2/cliente \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gestio.com.br/v2/cliente"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gestio.com.br/v2/cliente', 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.gestio.com.br/v2/cliente",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.gestio.com.br/v2/cliente"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.gestio.com.br/v2/cliente")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gestio.com.br/v2/cliente")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"nomeComercial": "Comercial Alfa",
"codigoDoCliente": 1023,
"razaoSocial": "Comercial Alfa Distribuidora Ltda",
"natureza": "J",
"seuCodigo": "<string>",
"cnpjcpf": "<string>",
"cnpj": "12345678000199",
"cpf": "12345678909",
"inscricaoEstadual": "<string>",
"inscricaoMunicipal": "<string>",
"indicadorContribuinte": "<string>",
"codigoDoTipoDeCliente": 123,
"descricaoDoTipoDeCliente": "<string>",
"codigoDoGrupoDeCliente": 123,
"codigoDaClassificacaoAuxiliar": 123,
"descricaoDoGrupoDeCliente": "<string>",
"codigoDoSegmento": "<string>",
"idRamoDeAtividade": 123,
"descricaoDoSegmento": "<string>",
"codigoDoVendedor": 123,
"descricaoDoVendedor": "<string>",
"codigoDaCategoria": 123,
"codigoDaSituacaoFinanceira": 123,
"descricaoDaCategoria": "<string>",
"descricaoDaSituacaoFinanceira": "<string>",
"endereco": {
"cep": "01311000",
"logradouro": "Av. Paulista",
"numero": "1578",
"complemento": "Conjunto 41",
"bairro": "Bela Vista",
"cidade": "São Paulo",
"uf": "SP",
"codigoDoMunicipio": "3550308"
},
"telefone": "(11) 4002-8922",
"site": "https://www.suaempresa.com.br",
"email": "[email protected]",
"receberEmailBoleto": true,
"paisExterior": true,
"codigoDoPais": 123,
"idExterior": "<string>",
"observacao": "<string>",
"observacaoFinanceiro": "<string>",
"textoLivre": "<string>",
"codigoDoRegimeTributario": 123,
"descricaoDoRegimeTributario": "<string>",
"contatoFinanceiro": "<string>",
"emailContatoFinanceiro": "<string>",
"telefoneFinanceiro": "<string>",
"emailsFinanceiro": [
"<string>"
],
"contatoFaturamento": "<string>",
"emailContatoFaturamento": "<string>",
"telefoneFaturamento": "<string>",
"aliquotaISSRetidoFaturamento": 123,
"dataDeCadastro": "2023-11-07T05:31:56Z",
"ativo": true,
"podeAtivar": true,
"podeDesativar": true,
"idClienteWS": "<string>",
"ultimaAtualizacao": "<string>",
"contatos": [
{
"codigoDoCliente": 1023,
"seqContato": 1,
"nomeDoContato": "Ana Beatriz Ferreira",
"nomeAbreviado": "Ana Ferreira",
"departamento": "Financeiro",
"telefone": "(11) 4002-8922",
"celular": "(11) 98877-6655",
"email": "[email protected]",
"observacao": "<string>",
"ativo": true
}
],
"podeEditar": true,
"nomeComercialFmt": "<string>"
}
}dataInferior/dataSuperior para limitar a janela consultada. Sem filtro, a resposta pode ser volumosa.Authorizations
Envie o token retornado por /v2/autenticar no header Authorization, no formato Bearer {token}.
Query Parameters
CNPJ ou CPF do cliente. Quando informado, ignora os demais filtros e retorna um único registro.
Identificador externo do cliente (IdClienteWS). Quando informado, ignora os demais filtros e retorna um único registro.
Data/hora inferior de atualização. Formatos aceitos: dd/MM/yyyy ou dd/MM/yyyy HH:mm.
Data/hora superior de atualização. Formatos aceitos: dd/MM/yyyy ou dd/MM/yyyy HH:mm.
