SOPCompass
Start free trial
Help center

List boards

Reference for GET /boards, which returns the workspace's boards (pillars) in display order, in one response.

Business plan Updated
On this page
  1. Parameters
  2. Request
  3. Response
  4. Errors
Shell
GET https://app.sopcompass.com/api/v1/boards

Scope: read only or read and write. Paginated: no; everything in one response.

Returns the workspace’s own boards, ordered by position. A board is one of the workspace’s pillars, or a board created before pillars existed. Use a board’s id as board_id on GET /sops to list the SOPs in all its libraries. Boards of workspaces that share libraries in aren’t listed.

Parameters

None.

Request

Shell
curl https://app.sopcompass.com/api/v1/boards \
  -H "Authorization: Bearer $SOPCOMPASS_API_KEY"
JavaScript
const res = await fetch("https://app.sopcompass.com/api/v1/boards", {
  headers: { Authorization: `Bearer ${process.env.SOPCOMPASS_API_KEY}` },
});
const { data: boards } = await res.json();
Python
import os
import requests

res = requests.get(
    "https://app.sopcompass.com/api/v1/boards",
    headers={"Authorization": f"Bearer {os.environ['SOPCOMPASS_API_KEY']}"},
    timeout=30,
)
boards = res.json()["data"]

Response

200 OK

JSON
{
  "data": [
    {
      "id": "9a1c4e2b-6d3f-4b8a-8c7e-1f2a3b4c5d02",
      "name": "Company",
      "pillar": "company",
      "position": 0,
      "library_count": 3,
      "created_at": "2026-08-30T12:00:00.000000Z"
    },
    {
      "id": "1b3d5f7a-9c2e-4a6b-8d0f-2a4c6e8b0d14",
      "name": "Fulfillment and delivery",
      "pillar": "fulfillment_delivery",
      "position": 4,
      "library_count": 5,
      "created_at": "2026-08-30T12:00:00.000000Z"
    },
    {
      "id": "7e9a1c3d-5f7b-4d9e-8a1c-3e5f7a9b1d21",
      "name": "Old procedures",
      "pillar": null,
      "position": 100,
      "library_count": 1,
      "created_at": "2026-06-02T09:31:45.004228Z"
    }
  ]
}
Field Type Description
id UUID The board’s id.
name string The board’s name as shown in the app.
pillar string or null The pillar this board is: company, lead_acquisition, lead_nurture, sales_execution, fulfillment_delivery or retention. null for a board created before pillars.
position integer Display order. Pillars are 0 to 5.
library_count integer Libraries on the board.
created_at timestamp When the board was created.

Errors

Status Code When
405 method_not_allowed POST instead of GET.

Authentication, plan and rate limit errors apply to every endpoint; see Errors.