List projects

​

Lists your projects, a page at a time. Only active projects come back unless you ask for others with filter[status].

Filtering

  • filter[title] — searches project titles, matching from the start of any word and ignoring case.
  • filter[public_url_token] — one or more URL tokens, for looking up projects you already hold a client link for.
  • filter[board_group_id] — one or more pipeline stage ids. Returns the projects whose board card sits in those stages.
  • filter[status] — which projects to include:
    • active (the default) — neither archived nor completed.
    • completed — finished but not archived.
    • archived — archived, whether or not they were completed.
    • not_archived — everything except archived projects.
    • all — every project, whatever its state.
Query Parameters
  • page[number]
    Type: integer
    min:  
    1

    Page to return, starting at 1.

  • page[size]
    Type: integer
    min:  
    1
    max:  
    100

    Records per page. Defaults to 25; anything above 100 is reduced to 100.

  • filter[title]
    Type: string

    Searches project titles, matching from the start of any word and ignoring case.

  • filter[public_url_token]
    Type: string

    One or more URL tokens, comma-separated or repeated.

  • filter[board_group_id]
    Type: string

    One or more pipeline stage ids, comma-separated or repeated. Returns the projects whose board card sits in those stages.

  • filter[status]
    Type: string enum

    Which projects to include. Defaults to active.

    values
    • active
    • archived
    • not_archived
    • completed
    • all
Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/public-api/v1/projects
curl https://app.hellobonsai.com/public-api/v1/projects \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": 51,
      "title": "Acme Website",
      "public_url_token": "acme-website-x4n2",
      "currency": "USD",
      "start_date": "2026-05-01",
      "sequence": 1,
      "number": "ACME-0001",
      "board_group_id": "0c8f1e2a-3b4c-4d5e-6f70-8192a3b4c5d6",
      "company_name": "Acme Corp",
      "billing_type": "fixed_fee",
      "billing_cycle": "monthly",
      "billing_fee": "5000.0",
      "company_id": 42,
      "url": "https://app.hellobonsai.com/projects/acme-website-x4n2"
    }
  ],
  "meta": {
    "request_id": "b1f0d2c4-7a9e-4c3b-8d5f-1e2a3b4c5d6e",
    "pagination": {
      "page": 1,
      "page_size": 25,
      "has_more": true
    }
  }
}

A page of projects.