Skip to Content
APIProjects

Projects

Projects are created and configured on the website; the token API reads them. List projects returns the summary shape ordered by descending id; Get project returns the full configuration.

List projects

Read the projects owned by your account, ordered by descending id. Use a project’s id as {id} / {projectId} in project-scoped requests.

The response is an unpaginated {results} collection — there is no cursor navigation on this endpoint.

GET/api/v1/projects/

Responses

200OKapplication/json

FieldTypeRequiredNotes
resultsobject[]yes
idstringyes
namestringyes
product_urlstringyes
meta_titlestringyes
meta_descriptionstringyes
descriptionstringyes
created_atstringyes
updated_atstringyes
{ "results": [ { "id": "b1a2c3d4-0000-4a5b-8c6d-7e8f9a0b1c2d", "name": "Acme Notion template", "product_url": "https://acme.example.com", "meta_title": "Acme", "meta_description": "Acme templates", "description": "Notion templates for indie hackers", "created_at": "2026-11-01T12:00:00.000000+00:00", "updated_at": "2026-11-10T09:30:00.000000+00:00" } ] }

All errors answer the standard problem body — this operation can also return 401, 429, 5xx, documented in Errors & retries.

Get project

Read one of your projects with its full configuration: keyword rules with their stable ids, competitors, and the effective lead prompt.

The keywords array lists raw values; keyword_rules is the authoritative structure to copy ids from.

GET/api/v1/projects/{id}/

Responses

200OKapplication/json

FieldTypeRequiredNotes
idstringyes
namestringyes
product_urlstringyes
meta_titlestringyes
meta_descriptionstringyes
descriptionstringyes
lead_custom_promptstringyes
lead_custom_prompt_effectivestringyes
lead_custom_prompt_sourcestringyes
keywordsstring[]yes
keyword_rulesobject[]yes
idstringyes
valuestringyes
targetstringyes
match_typestringyes
enabledboolean | nullyes
competitorsobject[]yes
idstringyes
websitestringyes
keyword_rulesobject[]yes
idstringyes
valuestringyes
targetstringyes
match_typestringyes
enabledboolean | nullyes
created_atstringyes
updated_atstringyes
{ "id": "b1a2c3d4-0000-4a5b-8c6d-7e8f9a0b1c2d", "name": "Acme Notion template", "product_url": "https://acme.example.com", "meta_title": "Acme", "meta_description": "Acme templates", "description": "Notion templates for indie hackers", "created_at": "2026-11-01T12:00:00.000000+00:00", "updated_at": "2026-11-10T09:30:00.000000+00:00", "lead_custom_prompt": "", "lead_custom_prompt_effective": "Score Reddit posts for buying intent.", "lead_custom_prompt_source": "default", "keywords": [ "notion template" ], "keyword_rules": [ { "id": "3c2b1a0d-1111-4e5f-8a9b-0c1d2e3f4a5b", "value": "notion template", "target": "post", "match_type": "exact", "enabled": true } ], "competitors": [ { "id": "9d8c7b6a-2222-4f5e-8d9c-0b1a2f3e4d5c", "website": "https://competitor.example.com", "keyword_rules": [ { "id": "5e4f3g2h-3333-4a5b-8c7d-6e5f4a3b2c1d", "value": "competitor.example.com", "target": "post_comment", "match_type": "all_words", "enabled": null } ] } ] }

All errors answer the standard problem body — this operation can also return 401, 404, 429, 5xx, documented in Errors & retries.

Last updated on