List Monitoring Subscriptions
GET/v1/monitoring-subscriptions
List Monitoring Subscriptions
Request​
Query Parameters
Possible values: [id
]
Field to sort by
Filter by organisation name, organisation ID, or organisation registry ID.
Filter monitoring subscriptions based on whether there is a recognised Organisation tied to the subscription
A cursor that points to where to start the page
Default value: 25
How many items per page, for pagination.
Responses​
- 200
- 400
- 401
- 403
Successfully retrieved a page of Monitoring Subscriptions
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
data object[]
Possible values: [live
, pending_validation_request
, validation_request_failed
, pending
, cancelled
]
results object
Possible values: [pass
, fail
]
registration object
Possible values: [yes
, no
]
warning objectnullable
Possible values: [clear
, flag
]
sanction objectnullable
Possible values: [clear
, flag
]
controversial objectnullable
Possible values: [clear
, flag
]
commercial objectnullable
Possible values: [clear
, flag
]
adverseMedia objectnullable
Possible values: [clear
, flag
]
hateSpeech objectnullable
Possible values: [clear
, flag
]
organisation object
_links object
{
"data": [
{
"id": "monitoringsubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"organisationId": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"validationRequestId": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"status": "live",
"configurationId": "hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"results": {
"complianceStatus": "fail",
"registration": {
"active": "no"
},
"warning": {
"status": "flag"
},
"sanction": {
"status": "flag"
},
"controversial": {
"status": "flag"
},
"commercial": {
"status": "flag"
},
"adverseMedia": {
"status": "clear"
},
"hateSpeech": {
"status": "flag"
}
},
"createdAt": "2020-10-13T17:46:54.000Z",
"organisation": {
"name": "Name of the organisation the Monitoring Subscription is attached to"
}
}
],
"object": "monitoring_subscription",
"totalResults": 33,
"pageSize": 25,
"_links": {
"current": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
"next": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
"prev": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D"
}
}
Bad request
- application/json
- Schema
- Example (from schema)
- IncorrectParams
- CursorError
Schema
error object
{
"error": {
"code": "string",
"title": "string",
"message": "string",
"reasons": [
"string"
]
}
}
400 Incorrect Parameters
{
"error": {
"code": "bad_request",
"title": "Bad request",
"message": "One or more of the inputs were invalid",
"reasons": [
"pageSize must be greater than or equal to 0"
]
}
}
Error in cursor parameter
{
"error": {
"code": "pagination/cursor_error",
"title": "Bad request",
"message": "Unable to find the next page"
}
}
Unauthorized
Forbidden (scope)
- application/json
- Schema
- Example (from schema)
Schema
error object
{
"error": {
"code": "forbidden",
"title": "Forbidden",
"message": "Access is denied due to missing scope permissions"
}
}