List board groups

​

Lists the stages of your deal and project boards, a page at a time.

Deals move through these stages, so this is where you turn a stage name such as Won into the board_group_id the deal endpoints take.

You only get the boards you are allowed to list: deal stages need permission to see deals, project stages need permission to see projects. Without either, the list comes back empty.

Filtering

  • filter[name] — partial, case-insensitive match on the stage name.
  • filter[resource_type] — Deal or Project, to return one board's stages only. Omit it to get both.

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[name]
    Type: string

    Partial, case-insensitive match on the stage name.

  • filter[resource_type]
    Type: "Deal" or "Project"enum

    Return one board's stages only. Omit to get both boards.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/public-api/v1/board_groups
curl 'https://app.hellobonsai.com/public-api/v1/board_groups?filter[name]=Won&filter[resource_type]=Deal' \
  --globoff \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "8feddf83-f0dc-4587-ac77-3236d509a5c4",
      "name": "Won",
      "color": "#ECECEC",
      "position": 3,
      "state": "complete",
      "deal_probability": "100.0",
      "resource_type": "Deal"
    }
  ],
  "meta": {
    "request_id": "b1f0d2c4-7a9e-4c3b-8d5f-1e2a3b4c5d6e",
    "pagination": {
      "page": 1,
      "page_size": 25,
      "has_more": true
    }
  }
}

A page of pipeline stages, grouped by board and ordered by their position on it.