---
title: "Get subscriptions"
method: GET
path: "/subscriptions/1/subscription/{channel}"
tags: ["platform", "subscriptions-api", "subscription"]
---

# Get subscriptions

`GET /subscriptions/1/subscription/{channel}`

## Request

- Base URL: `https://api.infobip.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.infobip.com/subscriptions/1/subscription/{channel}`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.infobip.com/auth/1/oauth2/token`
  - API key in header `Authorization`
  - API key in header `Authorization`
  - HTTP basic

Returns a list of all subscriptions for the specified channel with pagination. By default, the result is sorted by creation date in descending order.<br>The search can be used with various criteria passed via query parameters (all criteria combinations have <strong>AND</strong> semantic).<br><strong>Note.</strong>To avoid validation errors and inconsistent results query parameters need to be encoded  (see <strong>RFC 3986, section 2.1</strong>).<br><strong>Example</strong>. Find subscriptions having applications 'app1' and 'app2', and the resource '100200300400'.<pre>/subscriptions/1/subscription/SMS?applicationId=app1&applicationId=app2&resource=100200300400</pre>

## Path parameters

- `channel` 'AGENT_OS' | 'APPLE_MESSAGES_FOR_BUSINESS' | 'BLOCKLIST' | 'CUSTOMER_ENGAGEMENT' | 'EMAIL' | 'FACEBOOK' | 'KAKAO_ALIM' | 'KAKAO_BRAND_MESSAGE' | 'LINE' | 'MMS' | 'MOBILE_IDENTITY' | 'MOBILE_PUSH' | 'NUMBER_LOOKUP' | 'OPEN_CHANNEL' | 'RCS' | 'REGISTRATION' | 'SMS' | 'VIBER' | 'VOICE_VIDEO' | 'WEB_PUSH' | 'WHATSAPP' | 'ZALO', required

## Query parameters

- `page` integer
- `size` integer
- `applicationId` string
- `entityId` string
- `callsConfigurationId` string
- `resource` string
- `user` string

## Response `200`

Success.

- 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSubscriptionPage
  - `results` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSubscriptionResponse[]: The list of the results for this page.
    - `subscriptionId` string: Subscription ID.
    - `name` string: Subscription group name.
    - `subscriptionGroupId` string: Subscription group identifier.
    - `profile` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fIdOnlyProfileResponse: Notification profile.
      - `profileId` string: Unique profile ID.
      - `security` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fIdOnlySecurityResponse: Security configuration.
        - `authId` string: Unique authorization ID.
    - `events` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fSubscriptionEvent[]: List of events to subscribe.
      - union: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
        - string
        - 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fFormatAwareEvent
          - `format` string, required
          - `event` string, required
    - `criteria` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fApplicationEntityPair[]: List of applicationId/entityId pairs.
      - `applicationId` string: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic.
      - `entityId` string: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic.
      - `callsConfigurationId` string: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic.
    - `resources` string[]: List of resources.
    - `users` string[]: List of users.
    - `keywords` string[]: List of keywords.
  - `paging` 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33fPageInfo: Contains information about the page.
    - `page` integer, required
    - `size` integer, required
    - `totalPages` integer, required
    - `totalResults` integer, required

## Other responses

- `400`: Bad request.
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found.
- `429`: Too many requests.
- `500`: Internal Server Error

---

[API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)