Skip to content

Per-Org Subscriptions summary

GET {baseURl}/v2/subscriptions
Summary of subscriptions for an organization.

Example
https://clarity-data-api.clarity.io/v2/subscriptions?org=myorgVD43

Headers

  • x-api-key: the API key string.

Request

query parameter description
org string
required		 The ID of the organization.
Find it under the user profile section in Dashboard.
Example "myorgVD43"

Response

attribute description
subscribingOrg str The org passed in as a parameter on the request.
subscriptions array List of subscriptions issued to the organization.

Subscription

attribute description
subscriptionId string Unique identifier of the subscription.
subscriptionType string One of "public" (for reference sites), "licensed", "shared", or "temporary".
attachedToDatasourceId string Unique identifier of the datasource currently attached to the subscription.
timePeriodStart string The date on which the subscription begins.
Omitted from public subscriptions.
timePeriodEnd string The date on which the subscription ends.
Omitted from public subscriptions.
daysRemaining integer The number of days remaining in the subscription.
Omitted from public subscriptions.
sharedWith array For subscriptions with type "licensed", a list of org identifiers with which it has been shared.

Example 200 Response

{
    "subscribingOrg": "demoABCD",
    "subscriptions": [
        {
            "subscriptionId": "SDPXQ5PQN",
            "subscriptionType": "public",
            "attachedToDatasourceId": "DVYYF9007",
        },
        {
            "subscriptionId": "SDRY90SY6",
            "subscriptionType": "licensed",
            "attachedToDatasourceId": "DANJR1624",
            "timePeriodStart": "2022-12-12T00:00:00.000Z",
            "timePeriodEnd": "2024-12-11T00:00:00.000Z",
            "daysRemaining": 489,
            "sharedWith": [
                "someOrg123",
                "otherOrg77"
            ],
        },
        {
            "subscriptionId": "SD107AYE4",
            "subscriptionType": "shared",
            "attachedToDatasourceId": "DLTGJ2618",
            "timePeriodStart": "2023-01-01T00:00:00.000Z",
            "timePeriodEnd": "2033-01-01T00:00:00.000Z",
            "daysRemaining": 3432
        },
        {
            "subscriptionId": "SKY2ALUEE",
            "subscriptionType": "temporary",
            "attachedToDatasourceId": "DABCDEFGH",
            "timePeriodStart": "2023-01-01T00:00:00.000Z",
            "timePeriodEnd": "2023-02-01T00:00:00.000Z",
            "daysRemaining": -190
        }
    ]
}