Enumerate Subscriptions

GET /subscriptions

Lists subscriptions owned by the authenticated caller when owner is omitted. Supplying owner selects that owner's subscriptions, filtered by the caller's SubscriptionRead permissions. Supplying id selects the exact subscription and still applies its read permission. The default page size is 10 and the maximum is 100; results use nextToken pagination.

Required scope

subscription:read

Query parameters

idstring

Exact subscription ID to retrieve, subject to the caller's read permission.

ownerstring

Filter the results by the owner of the resource. Defaults to the authenticated caller's resources when omitted. Use '~caller' to make that scope explicit. Another owner can be selected only for resources the caller can read.

expandarray<string>

Expansion tokens that request related or computed fields for each result. When omitted, the response contains only the default, shallower set of fields for each result.

nextTokenstring

Opaque token for the next page of results. Pass the continuation token returned by the previous response, unchanged. Omit it to start from the first page.

maxResultsinteger

Maximum number of results to return in one page. Defaults to 100. Values from 1 through 100 are accepted.

minimum: 1

maximum: 100

Default: 100

Returns

200

Fields

resultsarray<Subscription>Required
paginationContextPaginationContext
errorsarray<Error>: Partial query errors collected while returning available results.

Errors

400 BAD_REQUEST

Invalid query parameter.

Check the request fields and any validation details, then correct the payload.

401 UNAUTHORIZED

Unauthorized — invalid or missing authentication token.

Obtain a valid access token, then retry.

403 INSUFFICIENT_PERMISSIONS

Forbidden — insufficient permissions for the requested owner.

Check the linked account and its permissions for the device or resource.

500 INTERNAL

Internal server error

Retry with backoff only when the operation is safe to repeat. Include the error code when reporting persistent failures.