# List Subscriptions
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/be/v1/subscriptions:
get:
summary: List Subscriptions
deprecated: false
description: >+
This endpoint can be used to list all the Organization's subscriptions
of events on the ROCKIT Edge.
### Required Permissions
`subscriptions.read`
See [Roles](https://edge.api.cloud.rockitplay.com/roles-3618377f0.md)
for more details.
tags:
- ROCKIT Edge - Backend API/Subscriptions
parameters:
- name: offset
in: query
description: Pagination offset.
required: false
example: 0
schema:
type: integer
- name: limit
in: query
description: Pagination limit.
required: false
example: 1
schema:
type: integer
default: 10
- name: order[]
in: query
description: >-
Sorting order. Supported fields for sorting: "name". +/- for
Ascending/Descending (no +/- results in ascending order)
required: false
example:
- '-name'
schema:
type: array
items:
type: string
- name: Authorization
in: header
description: >-
Use the access token obtained from [`POST
/be/v1/login`](https://edge.api.cloud.rockitplay.com/user-login-org-11611254e0.md)
or [`POST
/be/v1/refresh`](https://edge.api.cloud.rockitplay.com/refresh-11630082e0.md)
as Bearer token.
Mutually excluded with `x-rockit-api-key`.
required: true
example: Bearer {{_edge_org_admin_access_token}}
schema:
type: string
- name: x-rockit-tenant
in: header
description: >
Unique and immutable tenancy identifier obtained from the ROCKIT
Edge administrator.
Requires `x-rockit-username`,
`x-rockit-orgname` and `x-rockit-api-key`.
required: true
example: '{{EDGE_TENANT_NAME}}'
schema:
type: string
- name: x-rockit-orgname
in: header
description: >
Unique and immutable organization identifier obtained from the
ROCKIT Edge administrator.
Requires `x-rockit-tenant`,
`x-rockit-username` and `x-rockit-api-key`.
required: true
example: '{{EDGE_ORG_NAME}}'
schema:
type: string
- name: x-rockit-username
in: header
description: >
Unique and immutable username which is associated with the apikey.
Requires `x-rockit-tenant`, `x-rockit-orgname` and
`x-rockit-api-key`.
required: true
example: adminPrincipal
schema:
type: string
- name: x-rockit-api-key
in: header
description: >-
Unique and immutable apikey which is associated with an machine
user.
Mutually excluded with `Authorization` header. Requires
`x-rockit-tenant`, `x-rockit-username` and `x-rockit-orgname`.
required: true
example: '{{_adminPrincipal_apiKey}}'
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: >-
A string confirming that the retrieval of subscriptions
was successful.
subscriptions:
type: array
items:
type: object
properties:
event:
type: string
orgName:
type: string
type:
type: string
sender:
type: string
name:
type: string
slack:
type: object
properties:
channelId:
type: string
required:
- channelId
x-apidog-orders:
- channelId
x-apidog-ignore-properties: []
webhook:
type: object
properties:
url:
type: string
required:
- url
x-apidog-orders:
- url
x-apidog-ignore-properties: []
required:
- event
- orgName
- type
- sender
- name
- webhook
x-apidog-orders:
- event
- orgName
- type
- sender
- name
- slack
- webhook
x-apidog-ignore-properties: []
description: >-
An array of subscription objects that provides details
about each subscription (such as the event type, sender,
notification type, and receiver information like webhook
URL or Slack channel).
totalCount:
type: integer
description: >-
An integer representing the total number of subscriptions
returned by the query.
required:
- status
- subscriptions
- totalCount
x-apidog-orders:
- status
- subscriptions
- totalCount
x-apidog-ignore-properties: []
example:
status: success
subscriptions:
- event: end
orgName: someOrg
type: slack
sender: deploy
name: deploySlack
slack:
channelId: '#rockitplay-events'
- event: error
orgName: someOrg
type: webhook
sender: dltar
name: dltarWebhook
webhook:
url: http://example.com/webhook
- orgName: someOrg
event: exception
sender: dltar
type: webhook
name: dltarWebhook
webhook:
url: http://example.com/webhook
- orgName: someOrg
sender: deploy
event: end
type: webhook
name: deployWebhook
webhook:
url: http://example.com/webhook
- orgName: densowOrg
sender: deploy
event: error
type: webhook
name: deployWebhook
webhook:
url: http://example.com/webhook
totalCount: 5
headers: {}
x-apidog-name: Success
'400':
description: ''
content:
application/json:
schema:
type: object
properties: {}
x-apidog-orders: []
x-apidog-ignore-properties: []
headers: {}
x-apidog-name: Invalid Param
'401':
description: ''
content:
application/json:
schema:
title: ''
type: object
properties:
status:
type: string
description: >-
Indicates that the organization creation request was
rejected because of authentication problems.
error:
type: string
description: Contains an error identifier. (e.g."unauthorized")
message:
type: string
description: >-
Provides details such as "invalid token" to help diagnose
the failure.
x-apidog-orders:
- 01JQNJ3G6R8KERJX8T34Z64K2A
required:
- status
- error
- message
x-apidog-refs:
01JQNJ3G6R8KERJX8T34Z64K2A:
$ref: '#/components/schemas/unauthorized'
x-apidog-ignore-properties:
- status
- error
- message
headers: {}
x-apidog-name: Unauthorized
security: []
x-apidog-folder: ROCKIT Edge - Backend API/Subscriptions
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/732774/apis/api-14052806-run
components:
schemas:
unauthorized:
type: object
properties:
status:
type: string
description: >-
Indicates that the organization creation request was rejected
because of authentication problems.
error:
type: string
description: Contains an error identifier. (e.g."unauthorized")
message:
type: string
description: >-
Provides details such as "invalid token" to help diagnose the
failure.
required:
- status
- error
- message
x-apidog-orders:
- status
- error
- message
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes:
Bearer token:
type: bearer
scheme: bearer
description: >-
Enter your Access Token. You can obtain this by calling the /be/v1/login
endpoint. Use the Refresh token to get a new Access token when it
expires.
servers:
- url: https://Example-Server.com
description: Default
security: []
```