GuidesAPI ReferenceSign-UpRecipes
API Reference

Get all Subscriptions

get
https://api.consentric.io/v1/subscriptions

Returns a list of Subscriptions for the given Application Id. If no Application Id is provided, the endpoint returns Subscriptions for all applications you are authorised to access.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length between 1 and 50

The ID associated with the target Application.

int64
≥ 0
Defaults to 0

The index of the first record to return.

int32
1 to 100
Defaults to 20

The number of items to return in a page.

string
enum

The status of the Subscription.

  • active - Updates will be sent.
  • paused - Updates will not be sent. Instead, they will be discarded.
Allowed:
string
enum

The UpdateType representing the payload the client will receive.

  • citizen-emails - email message of citizen based emails to be sent to citizens.
  • consent-receipts - the delta for every update of the citizen's permissions and preferences.
  • effective-permission - the full current state of the citizen after every update.
Allowed:
Responses

Updated 5 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago