Growth OS API

Listar reuniões

Ordem por `startAt` crescente, paginação por cursor (`nextCursor`). `from`/`to` recortam por horário da reunião (opcionais). `status` default `scheduled` (canceladas fora, como sempre); use `status=all` para trazer canceladas com `canceledAt`. `calendarKey` = `key` de `GET /calendars`. Filtros de polling: `createdAfter`/`updatedAfter`. `recoveredFromAppointmentId` (issue #728): quando essa reunião foi criada pra um contato que tinha uma reunião anterior com `outcome:"noshow"` ainda sem recuperação, aponta pro id dela — carimbado sozinho na criação, nunca escolhido à mão. `null` = não recupera nada.

GET
/appointments

Ordem por startAt crescente, paginação por cursor (nextCursor). from/to recortam por horário da reunião (opcionais). status default scheduled (canceladas fora, como sempre); use status=all para trazer canceladas com canceledAt. calendarKey = key de GET /calendars. Filtros de polling: createdAfter/updatedAfter. recoveredFromAppointmentId (issue #728): quando essa reunião foi criada pra um contato que tinha uma reunião anterior com outcome:"noshow" ainda sem recuperação, aponta pro id dela — carimbado sozinho na criação, nunca escolhido à mão. null = não recupera nada.

AutorizaçãoBearer <token>

Chave de API (gos_…)

Em: header

Parâmetros de consulta

from?string
to?string
calendarKey?string
Length1 <= length <= 80
assigneeUserId?string
contactId?string
opportunityId?string
status?string
Default"scheduled"

Value in

  • "scheduled"
  • "canceled"
  • "all"
outcome?string

Value in

  • "realizada"
  • "noshow"
  • "reagendada"
createdAfter?string
updatedAfter?string
cursor?string
limit?integer
Range1 <= value <= 500
Default100

Corpo da resposta

application/json

curl -X GET "https://example.com/appointments"
{  "data": [    {      "id": "string",      "contactId": "string",      "contactName": "string",      "opportunityId": "string",      "title": "string",      "startAt": "string",      "endAt": "string",      "location": "string",      "conferenceUrl": "string",      "calendarKey": "string",      "assigneeUserId": "string",      "status": "scheduled",      "outcome": "realizada",      "source": "string",      "createdAt": "string",      "createdByUserId": "string",      "createdBySource": "crm",      "updatedAt": "string",      "canceledAt": "string",      "outcomeAt": "string",      "recoveredFromAppointmentId": "string"    }  ],  "nextCursor": "string"}