---
title: "Get subscriptions"
method: GET
path: "/subscriptions"
tags: ["subscriptions"]
---

# Get subscriptions

`GET /subscriptions`

## Request

- Base URL: `https://api.acculynx.com/webhooks/v2`
- URL: `https://api.acculynx.com/webhooks/v2/subscriptions`
- Auth: HTTP bearer

Retrieves all webhook subscriptions for your company. This endpoint returns a paginated list of webhook subscriptions, including: 
  - Subscription status (enabled/disabled) 
  - Consumer URLs where webhook events are sent 
  - Technical contact information 
  - Topics each subscription is listening for.
  - Integration type of the current subscription.

  Use the pagination parameters to control the number of results returned.
  Use the subscription status filter to narrow results by subscription state.

## Query parameters

- `pageSize` integer
- `pageStartIndex` integer
- `subscriptionStatusQueryFilter` 'All' | 'Active' | 'Inactive': Status filter for subscription queries

## Response `200`

A paged list of subscriptions

- SubscriptionCollection: A paginated collection of webhook subscriptions. Contains both pagination metadata and the list of subscriptions.
  - `count` integer: The total number of items available across all pages. Use this to calculate the total number of pages available.
  - `pageSize` integer: The number of items per page in this response. This reflects either your requested page size or the default value.
  - `pageStartIndex` integer: The starting index of this page of results. Use with pageSize to track your position in the overall result set.
  - `items` Subscription[]: The list of subscription objects for this page of results. Each item contains complete subscription details.
    - `_link` string, uri: The full URI that can be used to access this subscription. This is a convenience to avoid having to construct the URL yourself.
    - `id` string, uuid: The unique identifier of the subscription. Use this ID in path parameters when working with specific subscriptions.
    - `consumerUrl` string: The URL where webhook events are sent for this subscription. All webhook events will be sent as POST requests to this URL.
    - `createdDate` string, date-time: The date and time when this subscription was created. Always provided in UTC format.
    - `modifiedDate` string, date-time: The date and time when this subscription was last modified. Always provided in UTC format. Updates when any subscription property changes.
    - `status` 'enabled' | 'disabled': The current status of the subscription. - enabled: The subscription is active and will receive webhook events - disabled: The subscription is inactive and will not receive webhook events
    - `tech_contact` string, email: The technical contact email address for this subscription. AccuLynx will use this email to communicate important information about the subscription.
    - `topicNames` string[]: List of event topics this subscription is listening for. Only events matching these topic names will be sent to the consumer URL.
    - `integrationType` 'Api' | 'Zapier': The current integration type of the subscription.

## Other responses

- `400`: Bad Request - The server cannot process the request due to a client error. Common causes: - Invalid request format - Missing required fields - Validation errors in the request data
- `401`: Unauthorized - Authentication is required or has failed. Common causes: - Missing API key - Invalid API key - Expired or deactivated API key
- `416`: Range Not Satisfiable - The requested page of results is not available. Common causes: - pageStartIndex is beyond the available data range - Invalid pagination parameters

---

[API](https://skmtc.dev/acculynx/apis/webhooks-api.md) - [All operations](https://skmtc.dev/acculynx/apis/webhooks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/acculynx/apis/webhooks-api/revisions/8bc7679859d8?raw)