API reference
Every operation of the Token API, organized by resource. Pick the resource in the sidebar, then the operation in the page’s table of contents — every operation section has a stable anchor you can link to directly.
All requests go to https://api.intentloom.com with the header:
Authorization: Token <key>Use the Token scheme exactly — Bearer is never accepted for a personal
API token (authentication). URLs keep their trailing slash
exactly as documented.
Resources
- Projects — list your projects, read one project’s full configuration
- Project keywords — add, list, read, update and delete the project’s keywords
- Competitors — add, list, read, rename and delete competitor websites (creation seeds one default keyword)
- Competitor keywords — manage the keywords of one competitor
- Post leads — the cursor-paginated read for both lead surfaces, with filters and walkthroughs
- Comment leads — ordinary and competitor comments, with filters and cursor pagination
Lead types
All paths below are relative to /api/v1/projects/{projectId}.
| Lead type | Path | source_type |
|---|---|---|
| Post leads | /leads/ | lead (default) |
| Competitor post leads | /leads/ | competitor |
| Comment leads | /comment-leads/ | lead (default) |
| Competitor comment leads | /comment-leads/ | competitor |
Conventions
- Collections. Keyword and competitor lists return an unpaginated
{results}envelope. Post and comment leads are cursor-paginated: every page is{results, next, previous}and you follownextas-is (pagination). - Ids. Copy ids (
projectId,keywordId,competitorId) from list responses — foreign, unknown or misnested ids answer a non-disclosing404. - Writes share the website’s plan gates (
403 NO_ACTIVE_PLANor a plan-limit problem); reads require no active subscription. - Errors are RFC 9457 problem documents — fields, status codes and safe retry semantics are documented once in Errors & retries. Each operation below lists only its operation-specific errors.
The resource pages and the OpenAPI download render the same committed Token-only projection of the Worker’s OpenAPI contract.
Last updated on