API Reference

Authenticate with an API key, then list or create posts on a board. Base path is relative to your FeedFr host.

Authentication

Create a key in DashboardSettingsDeveloper. Send it on every request using either header:

Authorization: Bearer YOUR_API_KEY

# or

X-API-Key: YOUR_API_KEY

Keep keys secret. Revoke compromised keys immediately from the same settings page.

Base URL

https://your-domain.com/api/v1

Replace your-domain.com with the host where FeedFr is deployed (for example feedfr.com).

Endpoints

GET/boards/{slug}/posts

List posts for a board you can access with the authenticated key.

Query parameters

limit – optional, default 50
status – optional filter: UNDER_REVIEW | PLANNED | IN_PROGRESS | SHIPPED | DECLINED

Example

curl -s \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://feedfr.com/api/v1/boards/acme/posts?limit=20&status=PLANNED"

Response

{
  "posts": [
    {
      "id": "...",
      "title": "Dark mode for the dashboard",
      "description": "...",
      "status": "PLANNED",
      "category": "FEATURE",
      "createdAt": "...",
      "author": { "name": "...", "image": null }
    }
  ]
}

POST/boards/{slug}/posts

Create a post on a board. The API key owner is set as the author.

JSON body

title – required string
description – required string
category – optional (accepted by clients; ensure it matches product enums when provided)

Example

curl -s -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Export board as CSV",
    "description": "Need posts in a spreadsheet for quarterly planning."
  }' \
  "https://feedfr.com/api/v1/boards/acme/posts"

Response

// 201 Created
{
  "post": {
    "id": "...",
    "title": "Export board as CSV",
    "description": "...",
    "boardId": "...",
    "authorId": "..."
  }
}

Errors

401 – missing or invalid API key
404 – board not found
400 – invalid body (for example missing title or description on create)
500 – unexpected server error

{ "error": "Invalid API key" }

Webhooks

Board owners can configure webhooks in dashboard board settings to receive event notifications. Use the API for pull-based access to posts; use webhooks when you want push updates into your stack.

API Reference

Authenticate with an API key, then list or create posts on a board. Base path is relative to your FeedFr host.

Authentication

Create a key in DashboardSettingsDeveloper. Send it on every request using either header:

Authorization: Bearer YOUR_API_KEY

# or

X-API-Key: YOUR_API_KEY

Keep keys secret. Revoke compromised keys immediately from the same settings page.

Base URL

https://your-domain.com/api/v1

Replace your-domain.com with the host where FeedFr is deployed (for example feedfr.com).

Endpoints

GET/boards/{slug}/posts

List posts for a board you can access with the authenticated key.

Query parameters

limit – optional, default 50
status – optional filter: UNDER_REVIEW | PLANNED | IN_PROGRESS | SHIPPED | DECLINED

Example

curl -s \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://feedfr.com/api/v1/boards/acme/posts?limit=20&status=PLANNED"

Response

{
  "posts": [
    {
      "id": "...",
      "title": "Dark mode for the dashboard",
      "description": "...",
      "status": "PLANNED",
      "category": "FEATURE",
      "createdAt": "...",
      "author": { "name": "...", "image": null }
    }
  ]
}

POST/boards/{slug}/posts

Create a post on a board. The API key owner is set as the author.

JSON body

title – required string
description – required string
category – optional (accepted by clients; ensure it matches product enums when provided)

Example

curl -s -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Export board as CSV",
    "description": "Need posts in a spreadsheet for quarterly planning."
  }' \
  "https://feedfr.com/api/v1/boards/acme/posts"

Response

// 201 Created
{
  "post": {
    "id": "...",
    "title": "Export board as CSV",
    "description": "...",
    "boardId": "...",
    "authorId": "..."
  }
}

Errors

401 – missing or invalid API key
404 – board not found
400 – invalid body (for example missing title or description on create)
500 – unexpected server error

{ "error": "Invalid API key" }

Webhooks

Board owners can configure webhooks in dashboard board settings to receive event notifications. Use the API for pull-based access to posts; use webhooks when you want push updates into your stack.