GET
/
monitoring
/
alerts
List monitoring alerts
curl --request GET \
  --url https://api-sandbox.synctera.com/v0/monitoring/alerts \
  --header 'Authorization: Bearer <token>'
{
  "alerts": [
    {
      "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "metadata": {},
      "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "status": "ACTIVE",
      "title": "Ireland Competition and Consumer Protection Commission Criminal Court Cases",
      "type": "BANKRUPTCY",
      "urls": [
        "https://example.com/alert-document-1",
        "https://example.com/alert-document-2"
      ],
      "vendor_info": {
        "content_type": "application/json",
        "json": {},
        "vendor": "SOCURE"
      }
    }
  ],
  "next_page_token": "a8937a0d"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

id
string<uuid>[]

Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

business_id
string<uuid>[]

Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

person_id
string<uuid>[]

Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

Response

200
application/json

List of alerts.

The response is of type object.