Get started in three steps
- Check your plan. The API is part of Studio and Enterprise. Studio keys read ideas. Enterprise keys read ideas, projects and people.
- Create a key. An owner or admin opens Settings, Calendar & integrations, Developer API, names the key and chooses how long it lasts. The key is shown once, so copy it straight away.
- Make your first request. Send the key as a bearer token:
curl https://idealine.io/v1/ideas \
-H "Authorization: Bearer idl_live_YOUR_KEY"
The API is read-only today. It never creates, changes or deletes anything in your workspace.
Keys and keeping them safe
- A key belongs to one workspace and can never read another.
- We store only a one-way fingerprint of your key, so we cannot show it again. If you lose it, revoke it and make a new one.
- Keep keys on a server. Never put one in a web page, a mobile app or a public repository.
- Each workspace can have up to 10 active keys. Give each tool its own key so you can revoke one without breaking the others.
- Keys expire after the time you choose, up to two years. Creating and revoking a key is written to your activity log.
Endpoints
The base address is https://idealine.io/v1. Every response is JSON.
| Request | Returns | Plans |
|---|---|---|
GET /v1/workspace | The workspace this key belongs to | Studio, Enterprise |
GET /v1/ideas | A page of ideas | Studio, Enterprise |
GET /v1/ideas/{id} | One idea | Studio, Enterprise |
GET /v1/projects | A page of projects | Enterprise |
GET /v1/projects/{id} | One project | Enterprise |
GET /v1/members | A page of people in the workspace | Enterprise |
GET /v1/members/{id} | One person | Enterprise |
GET /v1/openapi.json | The machine-readable description of this API. No key needed. | Public |
What an idea looks like
{
"id": "6f1c0a52-5b9e-4d0e-9d3c-0c3e2b6c1a11",
"type": "idea",
"title": "Podcast pilot episode",
"notes": "Try the format with one guest first.",
"audience": "Mid-market IT leaders",
"goal": "200 registrations",
"stage": "exploring",
"tags": ["audio"],
"due": "2026-12-01",
"revisit": null,
"launched": false,
"project_id": null,
"steps": { "total": 4, "done": 1 },
"created_at": "2026-11-01T15:04:05Z",
"updated_at": "2026-11-06T09:12:40Z"
}
Ideas never include comments, who wrote them, or anything from AI assist. stage is one of raw, exploring, ready or parked. project_id is set once an idea has been promoted to a project.
Filtering, sorting and paging
List requests return up to 25 items by default. Ask for up to 100 with page[size]. Each response has a links.next address; follow it until it is null.
| Filter on ideas | Meaning |
|---|---|
filter[stage]=raw,exploring | Only these stages |
filter[launched]=false | true for ideas promoted to a project, false for the rest |
filter[due_before]=2026-12-31 | Due on or before this date. filter[due_after] works the same way. |
filter[updated_since]=2026-11-01T00:00:00Z | Changed after this time. Handy for a nightly sync. |
sort=updated_at | Oldest change first. The default, -updated_at, is newest first. |
Unknown filters are refused with a clear message rather than ignored, so a typo never quietly returns the wrong data.
Example: every idea still being worked on
const res = await fetch(
"https://idealine.io/v1/ideas?filter[stage]=raw,exploring,ready&page[size]=100",
{ headers: { Authorization: `Bearer ${process.env.IDEALINE_KEY}` } }
);
if (!res.ok) throw new Error((await res.json()).title);
const { data, links } = await res.json();
Rate limits and caching
- Each key can make 300 requests a minute. Every response carries
X-RateLimit-Limit,X-RateLimit-RemainingandX-RateLimit-Reset. - Requests from a single network address are also limited to 120 a minute across all keys, so give each integration its own server rather than sharing one address between many. Contact us if you need more.
- Over the limit you get a
429with aRetry-Afterheader. Wait that many seconds, then try again. - Responses include an
ETag. Send it back asIf-None-Matchand an unchanged page returns304with no body. Usefilter[updated_since]to fetch only what changed. - We watch for unusual traffic and may slow or pause a key that behaves like a scraper. Your other keys are not affected.
Errors
Errors use the standard application/problem+json shape, with a short title, a plain detail and a stable code you can match on.
{
"type": "https://idealine.io/v1/problems/plan_required",
"title": "Studio or Enterprise plan required",
"status": 403,
"code": "plan_required",
"detail": "The REST API is part of the Studio and Enterprise plans.",
"request_id": "a1b2c3d4"
}
| Status | When |
|---|---|
| 400 | A filter, page size or id is not valid |
| 401 | The key is missing, wrong, expired or revoked |
| 403 | The workspace's plan does not include this request |
| 404 | No such item in your workspace |
| 429 | Too many requests; see Retry-After |
| 502, 503 | A temporary problem on our side. Try again in a moment. |
How the API protects your data
- Read-only. There is no way to change your workspace through this API.
- One workspace per key. Every request is limited to the workspace the key belongs to, and an id from anywhere else answers as if it does not exist.
- Only safe fields. Responses list the fields documented above and nothing else. Comments, who wrote them, approvals and AI activity are never returned.
- Strict input. Filters are checked against a fixed list and every value is validated before a request is made.
- Revoke any time. A revoked, expired or downgraded key stops working on the next request.
Found a problem? Please tell us at security@idealine.io. More on how we protect workspaces is in the Trust Center.
More
- OpenAPI description for generating a client in your language.
- Plans and pricing
- Service status
Last updated November 7, 2026. This is version 1 of the API. We will not remove or rename documented fields in version 1 without notice.