Get Subscribers

get

https://api.cloud.mbanq.com/v1/subscribers

Use this API to retrieve all the configured subscribers.
This endpoint is useful for fetching a list of subscribers that have been set up for notifications.

It supports various filters and sorting options to customize the results.
Example Requests:

/subscribers?offset=0&limit=200
/subscribers?offset=0&limit=200&orderBy=id
/subscribers?activeOnly=false

Query Params

offset

integer

Indicates the result from which pagination starts. Defaults to 0.
Example: 0

limit

integer

Restricts the size of the results returned. Defaults to 200.
To override the default and return all entries you must explicitly pass
a non-positive integer value for limit e.g. limit=0, or limit=-1
Example: 20

orderBy

string

enum

The list is sorted by the indicated field.
Possible values - id, name, type, target.
Example: 'type'

Allowed:

sortOrder

string

enum

Specifies the sorting order. Possible values - ASC, DESC
Example: 'ASC'

Allowed:

activeOnly

boolean

Filter only active records if set to true. Return all if set to false. Default value is false.
Example: 'true'

Headers

tenantId

string

required

The ID of your banking instance visible in the MBANQ Console.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The list of subscribers is retrieved successfully.