WATCH COMPANIES / API REFERENCE

Start watching a company

Subscribe a company to selected change indicators.

POST/companies/{id}/watch/startOfficial reference

Parameters

idpath · integerRequired

Company ID returned by a company lookup. It is not the registration number.

fieldsbody · string[]Optional

Optional list of indicator keys. If omitted, all available watch fields are selected.

Working with this response

Set fields explicitly when you need a limited set of indicators. Omitting fields starts monitoring all available indicators.

Response

201 · no body documented

The reference documents HTTP 201, without a JSON response body.

Request example

curl --fail-with-body --request POST 'https://api.globaldatabase.com/v2/companies/YOUR_COMPANY_ID/watch/start' \
  --header "Authorization: Token $GDB_API_KEY" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "fields": [
    "company.status",
    "company.financial",
    "company.group_structure"
  ]
}'

Set GDB_API_KEY in your server environment. Replace YOUR_COMPANY_ID with the ID returned by your lookup. These examples are not executed by this page.