GET
/
v2
/
resthook_subscriptions
Get list of all resthook subscriptions
curl --request GET \
  --url https://{region}.affinda.com/v2/resthook_subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "count": 10,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": 2,
      "event": "document.parse.succeeded",
      "targetUrl": "https://my-site.com/receive",
      "active": true,
      "autoDeactivated": true,
      "autoDeactivateReason": "Resthook fails after 10 retries. The last error received was: 500 - Internal server error.",
      "version": "v3"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer 75z0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Query Parameters

​
offset
integer

The number of documents to skip before starting to collect the result set.

Required range: x >= 0
Example:

0

​
limit
integer

The numbers of results to return.

Required range: 1 <= x <= 100
Example:

20

Response

200
application/json

All matching resthook subscriptions.

The response is of type object.