Groups API

⚠️

Internal API. These endpoints power the FlowAlert dashboard and mobile app and authenticate with a session token — there is no public way to obtain one, and API keys cannot call them. Documented for transparency; may change without notice. The supported integration surface is POST /v1/events.

All endpoints require a Bearer token and workspace membership.

Create a group

POST /v1/workspaces/:workspaceId/groups

{ "name": "Booking Staff" }

Response 201:

{
  "id": "grp_abc123",
  "name": "Booking Staff",
  "workspaceId": "ws_xyz",
  "createdAt": "2026-05-11T12:00:00.000Z"
}

List groups

GET /v1/workspaces/:workspaceId/groups

Add a member

POST /v1/workspaces/:workspaceId/groups/:groupId/members

{ "userId": "usr_abc123" }

Remove a member

DELETE /v1/workspaces/:workspaceId/groups/:groupId/members/:userId

Delete a group

DELETE /v1/workspaces/:workspaceId/groups/:groupId

💡

Deleting a group does not delete routing rules that reference it — those rules will stop delivering notifications until reassigned to a new group.

Routing Rules Notifications