Savee Developers

Boards

GET
/v1/boards

Returns every board the caller can see as a tree in a single response (not paginated): personal boards they own, boards they collaborate on, and boards from any Savee Teams workspace they're a member of. Only top-level boards appear at the root of data; a board's children are nested under its sub_boards array (single-level, so each sub-board is a leaf). Use the ownership_type field on each board to tell user-owned boards apart from team boards. The order at every level follows the caller's chosen boards-sort preference on savee.com.

Authorization

headerAuthorizationBearer <token>

Personal access token (sv_live_…) — represents you and carries every scope, so no scope is required for this call. Best for your own scripts and internal tools. Generate one at https://savee.com/developers/.

Response Body

All boards visible to the caller, as a tree.

application/json
  1. response
data*array<>
curl -X GET 'https://api.savee.com/v1/boards'
{  "data": [    {      "id": "string",      "short_id": "string",      "name": "string",      "slug": "string",      "url": "http://example.com",      "is_private": true,      "saves_count": 0,      "created_at": "2019-08-24T14:15:22Z",      "og_image": "http://example.com",      "ownership_type": "team",      "sub_boards": [        {          "id": "string",          "short_id": "string",          "name": "string",          "slug": "string",          "url": "http://example.com",          "is_private": true,          "saves_count": 0,          "created_at": "2019-08-24T14:15:22Z",          "og_image": "http://example.com",          "ownership_type": "team",          "sub_boards": []        }      ]    }  ]}

Get a single board

GET
/v1/boards/{boardID}

boardID is either the board id or the short_id returned by /v1/boards; both are accepted and both are stable across renames. Returns the board with its child boards nested under sub_boards — the same shape as a node in the /v1/boards tree — so there is no separate sub-boards endpoint. Accessible by any user with a role on the board (owner, admin, editor, viewer) and by team members for team-owned boards. Returns 404 when the board does not exist or the caller has no role on it — the API does not confirm whether someone else’s board exists.

Authorization

headerAuthorizationBearer <token>

Personal access token (sv_live_…) — represents you and carries every scope, so no scope is required for this call. Best for your own scripts and internal tools. Generate one at https://savee.com/developers/.

Path Parameters

boardID*string

The board id, or its short_id — both are returned by /v1/boards.

Response Body

The board, with its sub-boards nested.

application/json
  1. response
data*
curl -X GET 'https://api.savee.com/v1/boards/string'
{  "data": {    "id": "string",    "short_id": "string",    "name": "string",    "slug": "string",    "url": "http://example.com",    "is_private": true,    "saves_count": 0,    "created_at": "2019-08-24T14:15:22Z",    "og_image": "http://example.com",    "ownership_type": "team",    "sub_boards": [      {        "id": "string",        "short_id": "string",        "name": "string",        "slug": "string",        "url": "http://example.com",        "is_private": true,        "saves_count": 0,        "created_at": "2019-08-24T14:15:22Z",        "og_image": "http://example.com",        "ownership_type": "team",        "sub_boards": []      }    ]  }}
GET
/v1/boards/{boardID}/saves

boardID is either the board id or the short_id returned by /v1/boards; both are accepted. Accessible by any user with a role on the board (owner, admin, editor, viewer) and by team members for team-owned boards. Returns 404 when the board does not exist or the caller has no role on it — the API does not confirm whether someone else’s board exists.

Authorization

headerAuthorizationBearer <token>

Personal access token (sv_live_…) — represents you and carries every scope, so no scope is required for this call. Best for your own scripts and internal tools. Generate one at https://savee.com/developers/.

Path Parameters

boardID*string

The board id, or its short_id — both are returned by /v1/boards.

Query Parameters

limit?integer

Page size (default 30, max 100).

Range1 <= value <= 100
cursor?string

Opaque cursor returned in next_cursor from the previous page. Pass it through verbatim — the encoding is an implementation detail and may change.

Response Body

A page of saves on the board.

application/json
  1. response
data*array<>
next_cursor*|

Pass as cursor to fetch the next page. null on the last page.

has_more*boolean

Whether another page is available. Keep paging while this is true.

curl -X GET 'https://api.savee.com/v1/boards/string/saves'
{  "data": [    {      "id": "string",      "short_id": "string",      "url": "http://example.com",      "name": "string",      "source_url": "string",      "created_at": "2019-08-24T14:15:22Z",      "is_private": true,      "total_saves": 0,      "media": {        "type": "image",        "width": 0,        "height": 0,        "thumbnail": "http://example.com",        "original": "http://example.com"      },      "detected_aesthetics": "string",      "colors": [        {          "color": "string",          "amount": 0        }      ],      "user": {        "id": "string",        "username": "string",        "name": "string",        "url": "http://example.com",        "avatar_url": "http://example.com"      }    }  ],  "next_cursor": "string",  "has_more": true}

On this page