Groups

Endpoints

Method	Path	Description
`GET`	`/api/v2/groups?pageId={page_id}`	List groups on a page
`POST`	`/api/v2/groups`	Create groups
`PATCH`	`/api/v2/groups/{group_id}`	Update a group
`DELETE`	`/api/v2/groups/{group_id}?pageId={page_id}`	Delete a group and its blocks

List groups

GET /api/v2/groups?pageId={page_id}

curl "https://api.flowla.com/api/v2/groups?pageId=<page_id>" \
  -H "x-flowla-api-key: YOUR_API_KEY"

import requests

response = requests.get(
    "https://api.flowla.com/api/v2/groups",
    headers={"x-flowla-api-key": "YOUR_API_KEY"},
    params={"pageId": "<page_id>"},
)

const res = await fetch(
  "https://api.flowla.com/api/v2/groups?pageId=<page_id>",
  { headers: { "x-flowla-api-key": "YOUR_API_KEY" } }
);

Create groups

POST /api/v2/groups Create one or more groups on a page in a single request.

pageId

string

required

The page to add groups to.

groups

array

required

Array of group objects.

Show Group object fields

title

string

Display title shown above the group.

Example

{
  "pageId": "<page_id>",
  "groups": [
    { "title": "Quick links" },
    { "title": "Resources" }
  ]
}

curl -X POST https://api.flowla.com/api/v2/groups \
  -H "x-flowla-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pageId": "<page_id>",
    "groups": [{ "title": "Quick links" }]
  }'

requests.post(
    "https://api.flowla.com/api/v2/groups",
    headers={"x-flowla-api-key": "YOUR_API_KEY"},
    json={
        "pageId": "<page_id>",
        "groups": [{"title": "Quick links"}],
    },
)

await fetch("https://api.flowla.com/api/v2/groups", {
  method: "POST",
  headers: {
    "x-flowla-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    pageId: "<page_id>",
    groups: [{ title: "Quick links" }],
  }),
});

Update a group

PATCH /api/v2/groups/{group_id}

pageId

string

required

The page the group belongs to.

title

string

New display title.

Example

{ "pageId": "<page_id>", "title": "Updated Group Title" }

curl -X PATCH https://api.flowla.com/api/v2/groups/<group_id> \
  -H "x-flowla-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"pageId": "<page_id>", "title": "Updated Group Title"}'

requests.patch(
    "https://api.flowla.com/api/v2/groups/<group_id>",
    headers={"x-flowla-api-key": "YOUR_API_KEY"},
    json={"pageId": "<page_id>", "title": "Updated Group Title"},
)

Delete a group

DELETE /api/v2/groups/{group_id}?pageId={page_id}

Deletes the group and all its blocks permanently. Any action-plan tasks inside the group are also deleted.

curl -X DELETE "https://api.flowla.com/api/v2/groups/<group_id>?pageId=<page_id>" \
  -H "x-flowla-api-key: YOUR_API_KEY"

requests.delete(
    "https://api.flowla.com/api/v2/groups/<group_id>",
    headers={"x-flowla-api-key": "YOUR_API_KEY"},
    params={"pageId": "<page_id>"},
)

Getting started

Rooms

Structure

Action Items

Automation

Lookups

Endpoints

List groups

Create groups

Update a group

Delete a group

​Endpoints

​List groups

​Create groups

​Update a group

​Delete a group

Endpoints

List groups

Create groups

Update a group

Delete a group