Growth OS API

Listar negócios

Paginação por cursor keyset; `limit` até 500. `contactId` filtra os negócios de um contato (§9.23). Datas em ISO-8601: `*After` é estritamente depois (`>`), `*Before` estritamente antes (`<`). `wonAfter`/`wonBefore` e `lostAfter`/`lostBefore` recortam pela data de fechamento (só negócios ganhos/perdidos); `stageChangedAfter` recorta por `stageChangedAt` (quando entrou no estágio atual).

GET
/opportunities

Paginação por cursor keyset; limit até 500. contactId filtra os negócios de um contato (§9.23). Datas em ISO-8601: *After é estritamente depois (>), *Before estritamente antes (<). wonAfter/wonBefore e lostAfter/lostBefore recortam pela data de fechamento (só negócios ganhos/perdidos); stageChangedAfter recorta por stageChangedAt (quando entrou no estágio atual).

AutorizaçãoBearer <token>

Chave de API (gos_…)

Em: header

Parâmetros de consulta

pipelineId?string
stageId?string
status?string

Value in

  • "open"
  • "won"
  • "lost"
contactId?string
createdAfter?string
updatedAfter?string
createdBefore?string
updatedBefore?string
wonAfter?string
wonBefore?string
lostAfter?string
lostBefore?string
stageChangedAfter?string
cursor?string
limit?integer
Range1 <= value <= 500
Default50

Corpo da resposta

application/json

curl -X GET "https://example.com/opportunities"
{  "data": [    {      "id": "string",      "title": "string",      "pipelineId": "string",      "stageId": "string",      "contactId": "string",      "status": "open",      "valueCents": -9007199254740991,      "currency": "string",      "ownerUserId": "string",      "temperature": "string",      "tags": [        "string"      ],      "lossReason": "string",      "expectedCloseAt": "string",      "wonAt": "string",      "lostAt": "string",      "customFields": {        "property1": null,        "property2": null      },      "createdAt": "string",      "updatedAt": "string",      "source": "string",      "utm": {        "source": "string",        "medium": "string",        "campaign": "string",        "term": "string",        "content": "string"      },      "origin": "string",      "stageChangedAt": "string",      "url": "string",      "firstHumanTouchAt": "string",      "lastHumanTouchAt": "string",      "lastActivityAt": "string"    }  ],  "nextCursor": "string"}