Skip to main content
GET
Retorna pessoas

Authorizations

​
x-api-key
string
header
required

Chave da API gerada no agulhão

Query Parameters

​
pagina
string
default:1

Página atual da busca

​
qtdePorPagina
string
default:100

Quantidade de usuários por página

​
ultimaAtualizacao
string<date-time>

Retorna apenas usuários que foram atualizados após a data informada

Example:

"2025-01-01T00:00:00"

​
vendedor
enum<string>
default:0

Retorna apenas usuários que são vendedores

Available options:
1,
0
​
cliente
enum<string>
default:0

Retorna apenas usuários que são clientes

Available options:
1,
0
​
guia
enum<string>
default:0

Retorna apenas usuários que são guias

Available options:
1,
0

Response

200 - application/json

Sucesso

​
id
string

Identificador único do usuário

Example:

"1"

​
razaoSocial
string

Razão social do usuário

Example:

"RAZÃO SOCIAL DA EMPRESA"

​
documento
string

CNPJ ou CPF do usuário

Example:

"00000000000000"

​
fantasia
string

Nome fantasia do usuário

Example:

"FANTASIA DA EMPRESA"

​
email
string

E-mail do usuário

Example:

"contato@empresa.com"

​
telefone
string

Telefone do usuário

Example:

"1112345678"

​
celular
string

Celular do usuário

Example:

"11912345678"

​
guia
boolean

Indica se o usuário é um guia

Example:

true

​
vendedor
boolean

Indica se o usuário é um vendedor

Example:

false

​
cliente
boolean

Indica se o usuário é um cliente

Example:

true

​
ultimaAtualizacao
string<date-time>

Data da última atualização do usuário

Example:

"2025-01-01T00:00:00"

​
endereco
object