Skip to main content
GET
/
v2
/
monitors
List monitored companies
curl --request GET \
  --url https://api.topograph.co/v2/monitors
{
  "monitors": [
    {
      "id": "cmfzlu1dt000j12ldeqrfszq0",
      "companyId": "123456789",
      "countryCode": "DE"
    }
  ],
  "total": 10,
  "hasNextPage": true,
  "nextCursor": "cmfzlu1dt000j12ldeqrfszq0"
}

Query Parameters

​
companyId
string

Filter by company ID

Example:

"123456789"

​
countryCode
enum<string>

Filter by country code (ISO 2-letter)

Available options:
AT,
BE,
CH,
CN,
CZ,
CY,
DE,
DK,
EE,
ES,
FI,
FR,
GB,
GG,
HK,
HR,
HU,
IE,
IT,
JE,
LI,
LU,
LV,
MC,
MT,
MU,
NL,
NO,
PL,
PT,
RO,
SE,
SK,
VG
Example:

"DE"

​
after
string

Cursor for pagination

Example:

"cmfzlu1dt000j12ldeqrfszq0"

​
first
number

Number of items to fetch (default: 50)

Required range: x >= 1
Example:

25

Response

List of monitors

​
monitors
object[]
required

List of monitored companies

​
total
number
required

Total number of monitors

Example:

10

​
hasNextPage
boolean
required

Whether there is a next page available

Example:

true

​
nextCursor
string

Cursor for the next page

Example:

"cmfzlu1dt000j12ldeqrfszq0"