Competitor Tracker & Co. Docs
Org

Take on the companies an agent picked, into the organization you already have.

Adds the companies to your current organization under the ordinary rules, so your coins are spent exactly as they would be had you added each company yourself. Name any of them in `decline` to leave it out. The link is single-use and is spent here rather than on the preview. Every company comes back with its own outcome, so a balance that runs out part-way through is reported rather than rolled back: what fitted is on file and the rest is named. The organization the agent created is removed once the companies have moved across.

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

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

POST
/v1/claims/{token}/accept

Authorization

X-API-Key<token>

In: header

Path Parameters

token*string

The single-use token from the claim link.

Length1 <= length <= 256

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://api.competitortracker.io/v1/claims/6f1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7e8f9/accept" \  -H "Content-Type: application/json" \  -d '{}'
{
  "status": "claimed",
  "organization": {
    "id": "string",
    "name": "string"
  },
  "companies": [
    {
      "competitorId": "string",
      "name": "string",
      "url": "string",
      "affiliated": true,
      "costCoins": 0,
      "outcome": "merged"
    }
  ],
  "shortfalls": [
    {
      "ask": "string",
      "reason": "unpublished"
    }
  ],
  "cost": {
    "companies": 0,
    "coinsPerCompany": 0,
    "coinsPerCycle": 0
  },
  "merged": 0,
  "expiresAt": "string",
  "claimedAt": "string"
}
{
  "code": "string",
  "message": "string",
  "resolution": "string"
}
{
  "status": "claimed",
  "organization": {
    "id": "string",
    "name": "string"
  },
  "companies": [
    {
      "competitorId": "string",
      "name": "string",
      "url": "string",
      "affiliated": true,
      "costCoins": 0,
      "outcome": "merged"
    }
  ],
  "shortfalls": [
    {
      "ask": "string",
      "reason": "unpublished"
    }
  ],
  "cost": {
    "companies": 0,
    "coinsPerCompany": 0,
    "coinsPerCycle": 0
  },
  "merged": 0,
  "expiresAt": "string",
  "claimedAt": "string"
}

Add more companies to an organization you started for someone. POST

Adds published companies to an unclaimed organization you created with `POST /v1/agent-signups`, so the three slots can be filled over several calls instead of all at once. Authenticate with the key that call returned; the organization is the one that key belongs to, and there is no way to name a different one. Companies are matched by name or domain against the ones we already track — no address you supply is ever fetched. The cap of three is on the TOTAL, so what is already on file counts, and anything that does not fit comes back in `shortfalls` and travels on the claim link. The link is updated to reflect what is now on file and what is still outstanding.

Leave the current organization. Sole owners must transfer ownership first; throws OwnershipTransferRequired otherwise. POST

Leave the current organization. Sole owners must transfer ownership first; throws OwnershipTransferRequired otherwise — Competitor Tracker & Co. API reference.