Idea board

List ideas

Paginated groups and ideas from the idea board (the planning page's data). Read-only; it never creates groups, so a brand-new workspace may return an empty groups array.

GET/api/v1/ideas
ideas:readread tierread-only

Authorization & guardrails

  • Send Authorization: Bearer <credential>; credentials are issued under Settings → Integrations → Long-lived credentials, see Authentication.
  • The credential needs scope ideas:read; the issuer's workspace role must also allow the action.
  • Rate limit: read tier, 60/min per credential; over the cap returns 429 with Retry-After.
  • Idempotency: read endpoint, no Idempotency-Key needed.
  • Read-only: writes nothing and sends nothing out.

Query parameters

groupIdstringoptional

One group only.

limitinteger 1–100optional

Page size, default 20.

cursorstringoptional

nextCursor from the previous page.

Responses

Success is HTTP 200 with a { data, meta } envelope; examples per status are on the right (at the end of the page on narrow screens). Every error is { error: { code, message, params }, meta } — branch on the code, not the message; see Errors.

StatusPossible codes
400invalid_input
401unauthenticated
403forbidden / workspace_not_found
404not_found
429rate_limited
500internal

Examples

Request
curl -X GET "https://popkit.loxily.com/api/v1/ideas" \
  -H "Authorization: Bearer popkit_it_••••••••"
Response
OK
{
  "data": {
    "groups": [
      {
        "id": "idg_01J8…",
        "name": "未分组",
        "isDefault": true
      },
      {
        "id": "idg_01J9…",
        "name": "十月活动",
        "isDefault": false
      }
    ],
    "ideas": [
      {
        "id": "ide_01J8ZS…",
        "groupId": "idg_01J9…",
        "content": "国庆档「一次创作,多平台发布」教程短视频",
        "tags": [
          {
            "label": "教程",
            "color": "blue"
          }
        ],
        "image": null,
        "plannedAt": "2026-09-28T02:00:00.000Z",
        "targetAccountIds": [],
        "createdBy": "usr_01J7…",
        "creatorName": "Amy",
        "createdAt": "2026-09-20T03:15:00.000Z"
      }
    ],
    "nextCursor": null,
    "deepLink": "https://popkit.loxily.com/planning"
  },
  "meta": {
    "requestId": "6a1d0c9e-2b7f-4e3a-8c5d-1f0e9b8a7c78"
  }
}