GET
/
v3
/
resthook_subscriptions
Get list of all resthook subscriptions
curl --request GET \
  --url https://{region}.affinda.com/v3/resthook_subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "count": 10,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": 123,
      "event": "document.parse.succeeded",
      "organization": {
        "identifier": "mEFayXdO",
        "name": "Grove Street King",
        "userRole": "admin",
        "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
        "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad",
        "isTrial": true,
        "validationToolConfig": {
          "theme": {
            "palette": {
              "mode": "light",
              "background": "<string>",
              "text": {
                "primary": "<string>",
                "secondary": "<string>",
                "disabled": "<string>"
              },
              "divider": "<string>",
              "primary": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "secondary": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "success": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "annotation": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "error": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "info": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "warning": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              }
            },
            "typography": {
              "fontFamily": "<string>",
              "fontSize": "<string>",
              "fontWeightRegular": "<string>",
              "fontWeightMedium": "<string>",
              "fontWeightBold": "<string>"
            },
            "borderRadius": 123,
            "fontUrl": "<string>"
          },
          "hideActions": true,
          "hideCollection": true,
          "hideEditPages": true,
          "hideExport": true,
          "hideFilename": true,
          "hideReject": true,
          "hideReparse": true,
          "hideRunOcr": true,
          "hideTags": true,
          "hideWarnings": true,
          "restrictDocumentSplitting": true,
          "disableCurrencyFormatting": true,
          "disableEditDocumentMetadata": true
        },
        "showCustomFieldCreation": true
      },
      "workspace": {
        "identifier": "mEFayXdO",
        "name": "<string>",
        "organization": {
          "identifier": "mEFayXdO",
          "name": "Grove Street King",
          "userRole": "admin",
          "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
          "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad",
          "isTrial": true,
          "validationToolConfig": {
            "theme": {
              "palette": {
                "mode": "light",
                "background": "<string>",
                "text": {
                  "primary": "<string>",
                  "secondary": "<string>",
                  "disabled": "<string>"
                },
                "divider": "<string>",
                "primary": {
                  "main": "<string>",
                  "light": "<string>",
                  "dark": "<string>",
                  "contrastText": "<string>"
                },
                "secondary": {
                  "main": "<string>",
                  "light": "<string>",
                  "dark": "<string>",
                  "contrastText": "<string>"
                },
                "success": {
                  "main": "<string>",
                  "light": "<string>",
                  "dark": "<string>",
                  "contrastText": "<string>"
                },
                "annotation": {
                  "main": "<string>",
                  "light": "<string>",
                  "dark": "<string>",
                  "contrastText": "<string>"
                },
                "error": {
                  "main": "<string>",
                  "light": "<string>",
                  "dark": "<string>",
                  "contrastText": "<string>"
                },
                "info": {
                  "main": "<string>",
                  "light": "<string>",
                  "dark": "<string>",
                  "contrastText": "<string>"
                },
                "warning": {
                  "main": "<string>",
                  "light": "<string>",
                  "dark": "<string>",
                  "contrastText": "<string>"
                }
              },
              "typography": {
                "fontFamily": "<string>",
                "fontSize": "<string>",
                "fontWeightRegular": "<string>",
                "fontWeightMedium": "<string>",
                "fontWeightBold": "<string>"
              },
              "borderRadius": 123,
              "fontUrl": "<string>"
            },
            "hideActions": true,
            "hideCollection": true,
            "hideEditPages": true,
            "hideExport": true,
            "hideFilename": true,
            "hideReject": true,
            "hideReparse": true,
            "hideRunOcr": true,
            "hideTags": true,
            "hideWarnings": true,
            "restrictDocumentSplitting": true,
            "disableCurrencyFormatting": true,
            "disableEditDocumentMetadata": true
          },
          "showCustomFieldCreation": true
        }
      },
      "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 aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. 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.