ACacculynx
subscriptions

Get subscriptions

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.

get/subscriptions

Request

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

Query parameters

pageSizeinteger

Controls how many items are returned per page in paginated responses.

  • Default: 25 items per page if not specified
  • Minimum: 1 item per page
  • Use with pageStartIndex for navigating through large result sets
pageStartIndexinteger

Specifies the starting position for paginated results.

  • Default: 0 (first page) if not specified
  • Minimum: 0
  • Example: pageStartIndex=25 with pageSize=25 returns the second page of results
subscriptionStatusQueryFilter'All' | 'Active' | 'Inactive'

Status filter for subscription queries

Example:Active

Filters subscriptions by their current status.

Allowed values:

  • All: Returns all subscriptions regardless of status (default)
  • Active: Returns only active subscriptions
  • Inactive: Returns only inactive subscriptions

When omitted, defaults to "All" and returns all subscriptions.

Response

A paged list of subscriptions

countinteger

The total number of items available across all pages. Use this to calculate the total number of pages available.

pageSizeinteger

The number of items per page in this response. This reflects either your requested page size or the default value.

pageStartIndexinteger

The starting index of this page of results. Use with pageSize to track your position in the overall result set.

Example response

{
  "items": [
    {
      "_link": "https://api.acculynx.com/webhooks/v2/subscriptions/b8270e49-f71d-4b49-aa0a-68bc75090ab5",
      "id": "01a7cfc1-2231-4589-9657-7f3004c06bd3",
      "consumerUrl": "https://www.your-domain.com/webhooks",
      "tech_contact": "support@your-company.com",
      "topicNames": [
        "milestone-changed"
      ]
    }
  ]
}

Changes

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