Saltar para o conteúdo principal
GET
/
v1
/
companies
Listar empresas
curl --request GET \
  --url https://api.vendaze.com/v1/companies \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "full_name": "Acme Corp",
      "emails": [
        {
          "email": "contato@acme.com",
          "reminder": "work"
        }
      ],
      "phones": [
        {
          "phone": "+551130000000",
          "reminder": "work"
        }
      ],
      "owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "permission": "all_users",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "per_page": 50,
    "has_more": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.vendaze.com/llms.txt

Use this file to discover all available pages before exploring further.

Autorizações

Authorization
string
header
obrigatório

OAuth 2.1 access token.

Parâmetros de consulta

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

Max 100.

Intervalo necessário: 1 <= x <= 100
order_by
string
padrão:created_at
order
enum<string>
padrão:desc
Opções disponíveis:
asc,
desc
full_name
string

Correspondencia parcial pelo nome da empresa.

email
string

Filtrar por endereco de e-mail.

phone
string

Filtrar por numero de telefone.

owner_user_id
string<uuid>

Filtrar por responsavel.

tag
string[]

Filtrar por tags. Logica AND.

created_after
string<date-time>
created_before
string<date-time>
updated_after
string<date-time>
updated_before
string<date-time>

Resposta

Lista de empresas retornada com sucesso.

data
object[]
meta
object