Saltar para o conteúdo principal
GET
/
v1
/
deals
Listar negócios
curl --request GET \
  --url https://api.vendaze.com/v1/deals \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Contrato Anual Acme Corp",
      "amount": 250000,
      "currency": "BRL",
      "formatted_amount": "R$ 2.500,00",
      "owner": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "João Silva",
        "email": "joao@empresa.com.br"
      },
      "source": "Minha Integração",
      "forecast_date": "2026-12-31T00:00:00Z",
      "entity_id": "NEG-0001",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 42,
    "page": 1,
    "per_page": 50,
    "has_more": false
  }
}

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

Registros por página. Máximo: 100.

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

Campo de ordenação.

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

Direção da ordenação.

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

Filtrar pelo nome do negócio (busca parcial, sem distinção de maiúsculas/minúsculas).

pipeline_id
string<uuid>

Filtrar pelo UUID do pipeline.

stage_id
string<uuid>

Filtrar pelo UUID da etapa.

source
string

Filtrar pela origem (correspondência exata). A origem é o nome do OAuth app que criou o negócio.

forecast_after
string<date-time>

Negócios com forecast_date igual ou posterior a esta data (ISO 8601).

forecast_before
string<date-time>

Negócios com forecast_date igual ou anterior a esta data (ISO 8601).

created_after
string<date-time>

Negócios criados igual ou após esta data (ISO 8601).

created_before
string<date-time>

Negócios criados igual ou antes desta data (ISO 8601).

updated_after
string<date-time>

Negócios atualizados igual ou após esta data (ISO 8601).

updated_before
string<date-time>

Negócios atualizados igual ou antes desta data (ISO 8601).

Resposta

Negócios listados com sucesso.

data
object[]
meta
object