Get subscriptions of a workspace

get/subscriptions/v1alpha1/subscriptions

Get subscriptions managed in a workspace. Pass filters to limit results based on conditional expressions.

NOTE: You need to have the view permission for the Devices and subscription service to invoke this API.

Rate limits are enforced on this API. 40 requests per minute is supported per workspace. API will result in 429 if this threshold is breached.

SecurityBearer
Request
query Parameters
filter
string

Filter expressions consisting of simple comparison operations joined by logical operators.

Example: filter=key eq 'MHNBAP0001' and key in 'PAYHAH3YJE6THY, E91A7FDFE04D44C339'
limit
integer <int64> [ 1 .. 2000 ]
Default: 2000

Specifies the number of results to be returned. The default value is 2000.

offset
integer <int64>
Default: 0

Specifies the zero-based resource offset to start the response from. Default value is 0.

select
Array of strings unique

A comma separated list of select properties to return in the response. By default, all properties are returned.

Example: select=id,key
sort
string

A comma separated list of sort expressions. A sort expression is a property name optionally followed by a direction indicator asc or desc. Default is ascending order.

Example: sort=key, quote desc
Responses
200

Successful response

400

Bad request

401

Unauthorized request

403

The operation is forbidden

422

Validation error

429

Too many requests

500

Internal server error

Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "count": 20,
  • "offset": 0,
  • "total": 100
}