v4

latestOpenAPI 3.1.02026-08-012402353.8 MB

List Event Subscriptions

get/event_subscriptions

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

idempotency_keystring

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Response

Event Subscription List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "created_at": "2020-01-31T23:59:59Z",
      "id": "event_subscription_001dzz0r20rcdxgb013zqb8m04g",
      "idempotency_key": null,
      "oauth_connection_id": null,
      "selected_event_categories": null,
      "status": "active",
      "type": "event_subscription",
      "url": "https://website.com/webhooks"
    }
  ],
  "next_cursor": "v57w5d"
}