Skip to main content
GET
/
v1
/
opportunities
Listar oportunidades
curl --request GET \
  --url https://api.timelyai.com.br/v1/opportunities \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "Projeto de automação",
      "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": 15000,
      "probability": 50,
      "stage": "prospecting",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "total_pages": 8
  }
}

Authorizations

​
x-api-key
string
header
required

Chave de API para autenticação. Obtenha sua chave em https://app.timelyai.com.br/developers

Query Parameters

​
page
integer
default:1

Número da página (começa em 1)

Required range: x >= 1
​
limit
integer
default:20

Quantidade de itens por página (máximo 100)

Required range: 1 <= x <= 100
​
sort
enum<string>
default:created_at

Campo para ordenação

Available options:
created_at,
updated_at,
title,
value,
probability,
stage
​
order
enum<string>
default:desc

Direção da ordenação

Available options:
asc,
desc
​
stage
enum<string>

Filtrar por estágio da oportunidade

Available options:
prospecting,
qualification,
proposal,
negotiation,
closing,
won,
lost
​
lead_id
string<uuid>

Filtrar por lead associado (UUID)

Response

Lista de oportunidades

​
data
object[]
​
pagination
object