---
updatedAt: 2026-06-23T11:32:21.000Z
agentTools:
  projectIndex: https://docs.zeplin.dev/llms.txt
---

# Get project flow board groups

List all flow board groups in a project.

**Returns** [Flow Board Group\[\]](/reference/flow_board_group)

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "title": "Zeplin API",
    "description": "Access your resources in Zeplin",
    "version": "0.0.0",
    "contact": {
      "name": "Zeplin",
      "url": "https://zeplin.io",
      "email": "support@zeplin.io"
    }
  },
  "servers": [
    {
      "url": "https://api.zeplin.dev"
    }
  ],
  "security": [
    {
      "OAuth2": []
    }
  ],
  "paths": {
    "/v1/projects/{project_id}/flow_boards/{flow_board_id}/groups": {
      "get": {
        "tags": [
          "Flows"
        ],
        "summary": "Get project flow board groups",
        "description": "List all flow board groups in a project.",
        "operationId": "GetProjectFlowBoardGroups",
        "parameters": [
          {
            "$ref": "#/components/parameters/project_id"
          },
          {
            "$ref": "#/components/parameters/flow_board_id"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response: Returns [Flow Board Group[]](/reference/flow_board_group)",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Flow Board Group",
                  "type": "object",
                  "properties": {}
                },
                "examples": {
                  "Board Group": {
                    "value": [
                      {
                        "$ref": "#/components/examples/flowBoardGroup/value"
                      }
                    ]
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/projectOrFlowBoardNotFound"
          },
          "422": {
            "$ref": "#/components/responses/projectArchived"
          }
        },
        "x-readme": {
          "samples-languages": [
            "node",
            "curl",
            "python",
            "swift",
            "kotlin"
          ],
          "code-samples": [
            {
              "language": "node",
              "code": "import { \n  ZeplinApi, \n  Configuration \n}  from \"@zeplin/sdk\";\n\nconst zeplin = new ZeplinApi(\n  new Configuration({ \n    accessToken: \"YOUR_ACCESS_TOKEN\"\n  })\n);\n\nconst { \n  data \n} = await zeplin.flows.getProjectFlowBoardGroups(\n  \"PROJECT_ID\",\n  \"FLOW_BOARD_ID\"\n);",
              "name": "sdk"
            }
          ]
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponse": {
        "title": "Error Response",
        "type": "object",
        "required": [
          "message"
        ],
        "properties": {
          "message": {
            "type": "string",
            "description": "A user readable descriptive message for the error"
          },
          "detail": {
            "type": "string",
            "description": "A detailed message describing the error"
          },
          "code": {
            "type": "string",
            "description": "The unique code for the error"
          }
        },
        "example": {
          "$ref": "#/components/examples/error"
        }
      }
    },
    "examples": {
      "flowBoardGroup": {
        "summary": "Flow Board Group",
        "value": {
          "id": "5dbad85a76ea51c1f35b6f69",
          "created": 1517184000,
          "name": "example board group name",
          "color": {
            "$ref": "#/components/examples/colorData/value"
          }
        }
      },
      "colorData": {
        "summary": "Color Data",
        "value": {
          "source_id": "0BEBFEB3-A107-4D1D-A3B0-77D1FBD35F01",
          "r": 143,
          "g": 152,
          "b": 5,
          "a": 1
        }
      },
      "error": {
        "summary": "Error",
        "value": {
          "message": "Project is not found"
        }
      }
    },
    "parameters": {
      "project_id": {
        "name": "project_id",
        "in": "path",
        "description": "Project id",
        "required": true,
        "schema": {
          "type": "string",
          "pattern": "/^[0-9a-f]{24}$/i"
        }
      },
      "flow_board_id": {
        "name": "flow_board_id",
        "in": "path",
        "description": "Flow Board id",
        "required": true,
        "schema": {
          "type": "string",
          "pattern": "/^[0-9a-f]{24}$/i"
        }
      }
    },
    "responses": {
      "projectArchived": {
        "description": "Project archived response",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "Project archived response": {
                "value": {
                  "message": "Project is archived"
                }
              }
            }
          }
        }
      },
      "projectOrFlowBoardNotFound": {
        "description": "Project or flow board not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "Project not found": {
                "value": {
                  "message": "Project not found"
                }
              },
              "Flow Board not found": {
                "value": {
                  "message": "Flow Board not found"
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "OAuth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "/v1/oauth/authorize",
            "tokenUrl": "/v1/oauth/token",
            "refreshUrl": "/v1/oauth/token",
            "scopes": {}
          }
        }
      }
    }
  }
}
```