curl --request GET \
--url https://api-integracoes.agulhao.com.br/pessoas \
--header 'x-api-key: <api-key>'[
{
"id": "1",
"razaoSocial": "RAZÃO SOCIAL DA EMPRESA",
"documento": "00000000000000",
"fantasia": "FANTASIA DA EMPRESA",
"email": "contato@empresa.com",
"telefone": "1112345678",
"celular": "11912345678",
"guia": true,
"vendedor": false,
"cliente": true,
"ultimaAtualizacao": "2025-01-01T00:00:00",
"endereco": {
"cidadeId": "1",
"cidadeNome": "São Paulo",
"uf": "SP",
"cep": "01000000",
"logradouro": "Avenida Paulista",
"numero": "1000",
"complemento": "Apto 101",
"bairro": "Bela Vista"
}
}
]Retorna pessoas
Retorna lista de pessoas cadastradas no sistema
curl --request GET \
--url https://api-integracoes.agulhao.com.br/pessoas \
--header 'x-api-key: <api-key>'[
{
"id": "1",
"razaoSocial": "RAZÃO SOCIAL DA EMPRESA",
"documento": "00000000000000",
"fantasia": "FANTASIA DA EMPRESA",
"email": "contato@empresa.com",
"telefone": "1112345678",
"celular": "11912345678",
"guia": true,
"vendedor": false,
"cliente": true,
"ultimaAtualizacao": "2025-01-01T00:00:00",
"endereco": {
"cidadeId": "1",
"cidadeNome": "São Paulo",
"uf": "SP",
"cep": "01000000",
"logradouro": "Avenida Paulista",
"numero": "1000",
"complemento": "Apto 101",
"bairro": "Bela Vista"
}
}
]Authorizations
Chave da API gerada no agulhão
Query Parameters
Página atual da busca
Quantidade de usuários por página
Retorna apenas usuários que foram atualizados após a data informada
"2025-01-01T00:00:00"
Retorna apenas usuários que são vendedores
1, 0 Retorna apenas usuários que são clientes
1, 0 Retorna apenas usuários que são guias
1, 0 Response
Sucesso
Identificador único do usuário
"1"
Razão social do usuário
"RAZÃO SOCIAL DA EMPRESA"
CNPJ ou CPF do usuário
"00000000000000"
Nome fantasia do usuário
"FANTASIA DA EMPRESA"
E-mail do usuário
"contato@empresa.com"
Telefone do usuário
"1112345678"
Celular do usuário
"11912345678"
Indica se o usuário é um guia
true
Indica se o usuário é um vendedor
false
Indica se o usuário é um cliente
true
Data da última atualização do usuário
"2025-01-01T00:00:00"
Show child attributes
Show child attributes