The article describes the steps for retrieving (all) subscriptions for your Bluedolphin tenant.
HTTP response status code | Interpretation |
200 OK | Subscription retrieved successfully |
400 Bad Request | Subscription could not be retrieved due to invalid tenant data passed |
401 Unauthorized | Subscription could not be retrieved due to the user not being authorized with the correct API key |
404 Not Found | Could not find subscription with specified ID |
500 Internal Server Error | The subscriptions couldn’t be retrieved due to a server error |
Make a GET request to /subscriptions
Resource/endpoint destination URL
The header for your API request
The {tenant} needs to be replaced with the tenant's name
The following query parameters are optional:
Include_disabled(includes based on subscription state)valid options:
trueoffalsebluedolphin_event (includes based on a specific event)
Supported events are
ObjectCreated, ObjectArchived, ObjectUpdated
Example API Request
curl --location --request GET 'https://public-api.eu.bluedolphin.app/v1/subscriptions?include_disabled=true' \
--header 'x-api-key: YOURAPIKEYSECRET' \
--header 'tenant: tenantName' \
--header 'Content-Type: text/plain' \
Successful Response:
A successful call returns a response with a 200 OK HTTP status code and the following body:
{
"total_items": 1,
"items": [
{
"id": "Unique identifier",
"last_updated_by": "Unique identifier",
"url": "Unique URL provided",
"bluedolphin_event": "Event Name",
"headers": {},
"status": 0,
"http_verb": "POST",
"lifecycle_state": "All"
}
]
}
Response properties
Property | Type | Description |
id | string | Unique identifier for the subscription |
last_updated_by | string | Unique identifier of the person who last updated/created the subscription |
url | string | The external url provided to which messages are sent |
bluedolphin_event | string | The event name for which the subscription was created |
headers | object | The headers are provided if needed, to make a request to an external Url with authorization tokens |
http_verb | string | The type of request to be made to the URL provided |
lifecycle_state | enum | The Lifecycle state to filter on. Values can be:
|