Competitor Tracker & Co. Docs

Claim the one-time allowance for tracking a whole industry list.

Tops an organization's balance up to cover every company on a curated list, once. Available to an organization that is not tracking anything yet, and only for a curated list — the amount comes from the list itself, never from the request. Claiming again returns the original outcome without granting more, so it is safe to retry.

Required role: member or higher (organization-level).

Required scope: competitors:write (for both OAuth2 tokens and API keys).

POST
/v1/track-lists/{slug}/grant

Authorization

X-API-Key<token>

In: header

Path Parameters

slug*string
Match^[a-z0-9-]+$
Length1 <= length <= 128

Response Body

application/json

application/json

application/json

curl -X POST "https://api.competitortracker.io/v1/track-lists/leave-management-software/grant"
{
  "eligible": true,
  "reason": "granted",
  "coinsGranted": 0,
  "balanceAfter": 0,
  "listLength": 0,
  "capped": true,
  "alreadyClaimed": true
}
{
  "code": "string",
  "message": "string",
  "resolution": "string"
}
{
  "code": "string",
  "message": "string",
  "resolution": "string"
}