Org
Organization-lifecycle operations: leave, transfer ownership, delete — the REST API reference for this group: every path with its parameters, the request body.
Organization-lifecycle operations: leave, transfer ownership, delete. Every endpoint below has a "try it" console. See the API reference overview for the base URL and how to authenticate.
POST /v1/agent-signups
Start tracking a few companies on someone's behalf, before they have an account.
GET /v1/claims/{token}
Read what an agent set up for you and what taking it on will cost.
POST /v1/agent-signups/companies
Add more companies to an organization you started for someone.
POST /v1/claims/{token}/accept
Take on the companies an agent picked, into the organization you already have.
POST /v1/org/leave
Leave the current organization.
POST /v1/org/transfer-ownership
Transfer ownership of the current organization.
GET /v1/org
Read the current organization, including the application domain it has claimed (null until one is set).
PATCH /v1/org
Rename the current organization.
DELETE /v1/org
Delete the current organization.
POST /v1/org/own-app-domain
Claim the organization's own application domain.
GET /v1/org/invites
List pending invitations for the current organization.
POST /v1/org/invites
Invite a new member to the organization.
POST /v1/org/referrals
Refer a friend to Competitor Tracker.
DELETE /v1/org/invites/{inviteId}
Revoke a pending invitation.
GET /v1/org/members
List active members of the current organization.
PATCH /v1/org/members/{userId}
Change the target member's role to `admin` or `member`.
List send and open events for a dispatch, newest-first. GET
Every send and open recorded for one dispatch, newest-first. Each entry names the recipient, what happened and when it happened. A send that did not get through is here too, with a short reason. Opens also say whether the reader looked like a person or an automated one. This is a log, not a report: there are no totals and no rates here.
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.