Read what an agent set up for you and what taking it on will cost.
Public, and gated only by the token in the link. Returns the companies an agent put on file for you, the coins each one costs per cycle, anything from the original request we could not deliver and where the claim stands. Looking costs nothing and uses nothing up: the link works until you accept it, so you can read this, walk away and come back. A link past its deadline still answers with the same companies, so you can sign up in the ordinary way with them already selected.
Path Parameters
The single-use token from the claim link.
1 <= length <= 256Response Body
application/json
application/json
application/json
curl -X GET "https://api.competitortracker.io/v1/claims/6f1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7e8f9"{
"status": "ready",
"companies": [
{
"competitorId": "string",
"name": "string",
"url": "string",
"affiliated": true,
"costCoins": 0
}
],
"shortfalls": [
{
"ask": "string",
"reason": "unpublished"
}
],
"cost": {
"companies": 0,
"coinsPerCompany": 0,
"coinsPerCycle": 0
},
"expiresAt": "string",
"claimedAt": "string"
}{
"code": "string",
"message": "string",
"resolution": "string"
}{
"status": "ready",
"companies": [
{
"competitorId": "string",
"name": "string",
"url": "string",
"affiliated": true,
"costCoins": 0
}
],
"shortfalls": [
{
"ask": "string",
"reason": "unpublished"
}
],
"cost": {
"companies": 0,
"coinsPerCompany": 0,
"coinsPerCycle": 0
},
"expiresAt": "string",
"claimedAt": "string"
}Start tracking a few companies on someone's behalf, before they have an account. POST
Creates an organization nobody owns yet, puts up to three of the companies you name on file, and returns a link the person you are acting for uses to take it over. Companies are matched against the ones we already track, by name or by domain, and the first three you list get the slots. Anything we could not deliver comes back in `shortfalls` and travels on the claim link, so the claim page can make good on the whole ask. The response also carries a short-lived key for reading what those companies have been up to. The organization expires in four days if nobody claims it. We send no email on this path: the claim link is yours to pass on.
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.