PolderAPI

Getting started

Introduction

What you can build with the Polder API, and where each of the three APIs lives.

Polder is one suite: Backlog (issues, projects, customers, incidents, assets, mailings), Docs (pages and databases) and Chat (channels, messages, contracts). Each has an HTTP API you call with a key, from a script, a server, a CI job or an app of your own. Everything the API does runs through the same permission checks as the screens: a key can do what the person who made it can do, and never more.

API Base URL Key For
Backlog API https://backlog.polder.work/api/v1 A personal API token with scopes Issues, projects, cycles, customers, initiatives, Notify, incidents, assets, inbox, activity
Docs API https://docs.polder.work/api/v1 An integration secret, shaped like Notion's API Pages, blocks, databases, comments
Chat API https://chat.polder.work/api/v1 A personal token from Chat Status, channels, messages, contracts

Note On a self-hosted install the three hosts may be one: the paths stay the same, only the host differs. Settings → API tokens in Backlog shows the address that is right for yours.

Make your first call

  1. Create a key: Authentication.
  2. Ask who you are:
curl https://backlog.polder.work/api/v1/me \
  -H "Authorization: Bearer $POLDER_TOKEN" \
  -H "Accept: application/json"
  1. Use a workspace id from the answer to read something:
curl "https://backlog.polder.work/api/v1/workspaces/7/issues?per_page=5" \
  -H "Authorization: Bearer $POLDER_TOKEN" \
  -H "Accept: application/json"

Where to go next

  • Making requests: workspaces in the URL, the response envelope, pagination.
  • Scopes: what each permission opens, so you can ask for as little as possible.
  • Rate limits and errors: what a 401, 403, 404, 422 and 429 mean here.
  • Other ways in: the CLI, the Raycast extension, webhooks and the MCP server for AI clients.