Get list of event subscriptions

This endpoint allows API users to retrieve the list of events the user account is subscribed to.

The results can be filtered and sorted. If the sort parameter is not indicated, the results are sorted by the created parameter in descending order. The filters and sort parameters need URL-encoding.

get/v2/event-subscriptions

Request

Base URL
https://api.signnow.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/signnow/apis/signnow-api/docs/v2/event-subscriptions/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

In how many pages to display the response.

Sort results by the date. Possible values: asc, desc. Format: ?sort[created]=desc

Sort results by the event type (from A to Z). Possible values: asc, desc. Format: ?sort[event]=desc

Sort results by the application name (from A to Z). Possible values: asc, desc. Format: ?sort[application]=desc

Search for a string in entity IDs and callback URLs. Format: ?filters=[{"_OR":[{"entity_id":{"type":"like","value":"21a28b47"}},{"callback_url":{"type":"like","value":"21a28b47"}}]}]

Filter results by the timestamps. Format: ?filters=[{"date":{"type":"between","value":[1580719773,1580720509]}}]

Filter results by the specific type of event. Format: ?filters=[{"event":{"type": "in", "value":["document.create", "document.update"]}}]

Filter results by the application. Format: ?filters=[{"application":{"type": "in", "value":["applicationUniqueId1", "applicationUniqueId2"]}}]

Include the number of events that triggered the webhook to the response. If set to true, the number is returned in the event_count field.

Headers

application/json

Response

Correct request with the filter by application ID.

Changes

No recorded changes to this operation across all 1 revision of this API.