---
title: "Get Board Pin List"
method: GET
path: "/v3.0/pinned-boards/"
tags: ["pinned-boards"]
---

# Get Board Pin List

`GET /v3.0/pinned-boards/`

## Request

- Base URL: `https://api.formaloo.me`
- URL: `https://api.formaloo.me/v3.0/pinned-boards/`
- Auth: none declared. Required headers: `x-api-key`

# Get list of pinned boards

This endpoint gives you a list of boards (apps) pinned by the current user in th current workspace. This list can contain all the boards owner by or shared with the user. The list is paginated and searchable. Items of the list are the same as the normal board list.

## Query parameters

- `page` integer
- `search` string

## Headers

- `x-api-key` string, required
- `x-workspace` string

## Response `200`

- PaginatedBoardListList
  - `count` integer
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `page_size` integer
  - `page_count` integer
  - `current_page` integer
  - `boards` BoardList[]
    - `user_form` string, nullable
    - `copied_from` string
    - `tags` string[]: tags's slug.
    - `pinned` boolean: shows if the board is pinned by the current user.
    - `excerpt` string, nullable: an optional excerpt on the board to be searched on.
    - `folder` string, nullable
    - `is_shared` boolean: shows if the board is shared by the current user or user is the owner.
    - `white_label` string
    - `full_board_address` string
    - `form_visit_count` string: shows the visit count of the board's main form if it has exactly one form.
    - `form_submit_count` string: shows the submit count of the board's main form if it has exactly one form.
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `slug` string
    - `is_primary` boolean: shows if this board is the primary board for the primary form.
    - `is_public` boolean: shows if this board can be displayed publicly.
    - `is_template` boolean: shows if this board can be used as a template.
    - `template_type` 'board' | 'form'
    - `title` string, nullable: an optional short title to identify the board by.
    - `description` string, nullable: an optional description on the board.
    - `share_address` string, nullable: an auto-generated address to share the board with.
    - `config` object, nullable
    - `theme_config` object, nullable
    - `copy_info` object
    - `thumbnail_url` string: the thumbnail's url.
    - `banner_slug` string, nullable: the banner's slug.
    - `banner_url` string: the banner's url.
    - `logo_slug` string, nullable: the logo's slug.
    - `logo_url` string: the logo's url.
    - `icon_slug` string, nullable: the icon's slug.
    - `icon_url` string, nullable: the icon's url.
    - `custom_domain` string, nullable: user can set this on the board, if they want to show this board on a custom domain (e.g. https://example.co/).
    - `version` string: version of board
    - `custom_css` string, nullable: enter custom css to be applied to board. this CSS will not be sanitized.
    - `custom_js` string, nullable: enter custom js to be run in board. this js will not be sanitized.
    - `primary_form` integer, nullable: the primary form related to this board.
    - `template` integer, nullable: the template related to this board.

---

[API](https://skmtc.dev/formaloo/apis/formaloo-api-documentation.md) · [All operations](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/revisions/47b268aeb656?raw)