List Monitoring Subscriptions

GET 
/v1/monitoring-subscriptions

List Monitoring Subscriptions

Request

Query Parameters

sort string

Possible values: [id]

Field to sort by

query string
Filter by organisation name, organisation ID, or organisation registry ID.
Example: save
hasOrganisation boolean

Filter monitoring subscriptions based on whether there is a recognised Organisation tied to the subscription

cursor string

A cursor that points to where to start the page

pageSize integer
How many items per page, for pagination.
Default value: 25

Responses

200

Successfully retrieved a page of Monitoring Subscriptions

application/json

Schema

Schema

data

object[]

Array [

idstring

Example: monitoringsubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationIdstringnullable

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

validationRequestIdstringnullable

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

statusstring

Possible values: [live, pending_validation_request, validation_request_failed, pending, cancelled]

Example: live

configurationIdstring

Example: hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

results

object

complianceStatusstringnullable

Possible values: [pass, fail]

Example: fail

registration

object

activestring

Possible values: [yes, no]

Example: no

warning

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

sanction

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

controversial

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

commercial

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

adverseMedia

object

nullable

statusstring

Possible values: [clear, flag]

Example: clear

hateSpeech

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

organisation

object

namestringnullable

Example: Name of the organisation the Monitoring Subscription is attached to

]

objectstring
Example: monitoring_subscription
totalResultsinteger
Example: 33
pageSizeinteger
Example: 25

_links

object

currentstring

Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D

nextstring

Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D

prevstring

Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D

Example (from schema)

{
  "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"
  }
}

400

Bad request

application/json

Schema

Schema

error

object

codestring

titlestring

messagestring

reasonsstring[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

IncorrectParams

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"
    ]
  }
}

CursorError

Error in cursor parameter

{
  "error": {
    "code": "pagination/cursor_error",
    "title": "Bad request",
    "message": "Unable to find the next page"
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

codestring

Example: forbidden

titlestring

Example: Forbidden

messagestring

Example: Access is denied due to missing scope permissions

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}