Events

What changed in the account, in order, with 30 days of history — incremental sync. Events are lean: ids and the names of the changed fields; the detail comes from reading the resource.

GET/v1/events— What changed

The account's events in order, with 30 days of history. Keep nextCursor and send it back next time — it always comes, even when there is nothing new. Each type also requires the resource's read permission. An event takes from seconds to over a minute to show up: follow the CURSOR, never the clock.

Permission: events:read

Query parameters

limitinteger: Items per page: 1 to 500 (default 100).
cursorstring: The nextCursor from the previous page. The list is over when it comes back null. It is only valid for this route and this account.
sincestring: Start from this date/time (only without a cursor).
typesstring: Only these types, comma-separated.

Response200OK

datalist of Eventrequired: The events, in order.
nextCursorstringrequired: Where to continue (always present).
hasMorebooleanrequired: There is more to read right now.

Example

curl -X GET 'https://api.imobyflow.com.br/v1/events' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en'

Errors for this route

And the errors common to every route

Objects

Event

An event.

idstringrequired: Event id (evt_…) — the same webhook-id as the delivery. Use it to avoid processing twice.
typestringrequired: Type.one of property.created property.updated property.deleted property.restored property.purged lead.created lead.updated lead.deleted lead.restored lead.purged radar.client_summary partnership.created partnership.updated captacao.offer_received captacao.offer_accepted captacao.offer_withdrawn
createdAtstringrequired: When it was recorded (UTC).
dataobjectrequired: What changed, lean: ids, state and changedFields (the NAMES of the changed fields). Never name, phone, e-mail or address — fetch the detail by reading the resource.