---
title: "Get list of event subscriptions"
method: GET
path: "/v2/event-subscriptions"
---

# Get list of event subscriptions

`GET /v2/event-subscriptions`

## Request

- Base URL: `https://api.signnow.com`
- URL: `https://api.signnow.com/v2/event-subscriptions`
- 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)

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.

## Response `200`

Correct request with the filter by application ID.

- object
  - `data` object[]: List of event subscriptions.
    - `id` string: Unique identifier of the event subscription.
    - `event` string: Event name that triggers the subscription. Check [list of events](/docs/guides-webhooks#entity-events).
    - `action` string: Action performed when the event occurs (for example, callback).
    - `active` boolean: Indicates whether the subscription is currently active.
    - `created` integer: Timestamp (Unix time) indicating when the subscription was created.
    - `version` integer: Subscription schema version.
    - `entity_id` integer: Internal numeric ID of the entity.
    - `entity_type` string: Type of entity the subscription is linked to (`document`, `document_group`, `user`).
    - `event_count` unknown
    - `request_method` string: HTTP method used for the callback request.
    - `json_attributes` object: Additional callback configuration details.
      - `headers` object: Custom headers sent with each callback request, as key-value pairs.
      - `secret_key` string: Secret key used to sign callback requests with HMAC. `null` if not set.
      - `use_tls_12` boolean: Whether TLS 1.2 should be used for the callback.
      - `callback_url` string: URL that receives the event callback.
      - `docid_queryparam` boolean: Whether the document ID is included as a query parameter.
      - `include_metadata` boolean: Whether document metadata is included in the callback payload.
    - `application_name` string: Name of the application that owns the subscription.
    - `entity_unique_id` string: Unique string ID of the entity.
    - `event_subscription_owner_email` string: Email address of the user who created the subscription.
  - `meta` object: Metadata for pagination.
    - `pagination` object: Pagination details.
      - `count` integer: Number of items returned in this response.
      - `links` object: Links to the adjacent pages. An empty array if there are no other pages.
        - `next` string: URL of the next page. Returned only if there is a next page.
        - `previous` string: URL of the previous page. Returned only if there is a previous page.
      - `total` integer: Total number of items available.
      - `per_page` integer: Number of items per page.
      - `total_pages` integer: Total number of pages.
      - `current_page` integer: The current page number.

## Other responses

- `400`: * Incorrect filter format (each filter must contain `type` and `value` fields). * Incorrect filter expression (must be a string). * Incorrect `application` filter expression (must be `"type": "in"`). * Incorrect `event` filter expression (must be `"type": "="` or `"type": "in"`). * Incorrect `entity_id` or `callback_url` filter expression (must be `"type": "like"`). * Incorrect `application` or `event` filter value (must be an array of strings). * Incorrect `entity_id` or `callback_url` filter value (must be a string). * Incorrect `date` filter value (must be an array).

---

[API](https://skmtc.dev/signnow/apis/signnow-api.md) - [All operations](https://skmtc.dev/signnow/apis/signnow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signnow/apis/signnow-api/revisions/1c9c30a6142b?raw)