SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
Sales Pipelines

List boards

Returns every active board with its stages, open deal count and open value, default board first. Every workspace has a default board, marked with is_default true. Boards and their stages are created and edited in the SoftSolz dashboard; use a board id from here to list and add deals, and a stage id to filter or move deals.

GEThttps://app.softsolz.uk/api/v1/services/pipelines/pipelines

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Query Params

limitinteger

Page size, 1-200 (default 50).

offsetinteger

Number of boards to skip (default 0).

Response

Response Body · array of objects

idstringBoard id.
namestringBoard name.
descriptionstring | nullShort description of what the board is for.
currencystring | nullThree-letter currency code the board reports in, or null when none is set.
is_defaultbooleanWhether this is the workspace default board. Exactly one active board is the default.
archivedbooleanAlways false here: archived boards are not listed.
deal_countintegerNumber of deals on the board, open, won and lost.
stage_countintegerNumber of stages on the board.
open_dealsintegerNumber of open deals on the board.
open_value_centsintegerTotal value of the open deals, in minor units (pence or cents).
created_atstringWhen the board was created.
updated_atstringWhen the board was last changed.
stagesarray of objectsThe board stages in order. Use a stage id to filter deals or to move a deal with the update call.

Request

curl --request GET \
  --url https://app.softsolz.uk/api/v1/services/pipelines/pipelines \
  --header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
  "data": [
    {
      "id": "12",
      "name": "New business",
      "description": "Inbound and outbound sales",
      "currency": "GBP",
      "is_default": true,
      "archived": false,
      "deal_count": 31,
      "stage_count": 6,
      "open_deals": 14,
      "open_value_cents": 2450000,
      "created_at": "2026-09-01T09:00:00.000Z",
      "updated_at": "2026-09-20T14:30:00.000Z",
      "stages": [
        {
          "id": "71",
          "name": "Proposal sent",
          "sort_order": 2,
          "win_probability": 50,
          "outcome": "open",
          "rotting_days": 14
        }
      ]
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "has_more": false
  }
}