List monitored companies

GET /v2/monitors

List monitored companies

cURL

curl --request GET \
  --url https://api.topograph.co/v2/monitors \
  --header 'x-api-key: <api-key>'

200

{
  "monitors": [
    {
      "id": "cmfzlu1dt000j12ldeqrfszq0",
      "companyId": "123456789",
      "countryCode": "DE",
      "companyName": "Topograph SAS"
    }
  ],
  "total": 10,
  "hasNextPage": true,
  "nextCursor": "cmfzlu1dt000j12ldeqrfszq0"
}

Authorizations

x-api-key · string · header · required

Query Parameters

companyId · string

Filter by company ID

Example:

"123456789"

countryCode · enum<string>

Filter by country code (ISO 2-letter)

Available options: AT, BE, BG, CH, CN, CZ, CY, DE, DK, EE, ES, FI, FR, GB, GG, GR, HK, HR, HU, IE, IS, IT, JE, LI, LU, LV, MC, MT, MU, NL, NO, PL, PT, RO, RU, SE, SG, SI, 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

200

application/json

List of monitors

monitors · object[] · required

List of monitored companies

Show child attributes

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"