Skip to main content
GET
Listar empresas

Autorizações

Authorization
string
header
obrigatório

Access token OAuth 2.1.

Parâmetros de consulta

page
integer
padrão:1

Número da página.

Intervalo necessário: x >= 1
per_page
integer
padrão:50

Número de registros por página. Máximo: 50.

Intervalo necessário: 1 <= x <= 50
order_by
enum<string>
padrão:created_at

Campo para ordenação.

Opções disponíveis:
created_at,
updated_at,
full_name
order
enum<string>
padrão:desc

Direção da ordenação.

Opções disponíveis:
asc,
desc
full_name
string

Filtrar por nome da empresa (contém, sem distinção de maiúsculas).

email
string<email>

Filtrar por endereço de e-mail (match exato). Busca em todos os e-mails da empresa.

created_after
string<date-time>

Retorna registros criados a partir desta data ISO 8601.

created_before
string<date-time>

Retorna registros criados até esta data ISO 8601.

updated_after
string<date-time>

Retorna registros atualizados a partir desta data ISO 8601.

updated_before
string<date-time>

Retorna registros atualizados até esta data ISO 8601.

Resposta

Empresas retornadas com sucesso.

data
object[]
meta
object