Watchlist

Add company to watchlist

Adds a company to the watchlist of the user account linked to the API key.

The company is identified by KRS (Polish court registry number). Digits only; leading zeros are optional (normalized to 10 digits server-side).

If the company is already on the watchlist, the response returns already_following: true and does not create a duplicate entry.

Requires an API key associated with a Compabase portal user account (user_id on the key).

post/watchlist/krs/{krs}

Request

  • Base URL: https://compabase.com/api/v1
  • URL: https://compabase.com/api/v1/watchlist/krs/{krs}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

krsstring required

KRS input is normalized by stripping non-digits and left-padding to 10 digits. After normalization, KRS must contain exactly 10 digits; otherwise request fails with 400 INVALID_KRS.

Response

Company added to watchlist (or already followed).

krsstring required

Normalized 10-digit KRS.

entity_idstring uuid required

Internal company identifier.

already_followingboolean required

True if the company was already on the watchlist before this request.

created_atstring date-time nullable

When the watchlist entry was created. Null when already_following is true and the original timestamp is unavailable.

Example response

{
  "krs": "0000028860"
}

Changes

No recorded changes to this operation across all 1 revision of this API.