Skip to content

List groupings

GET /api/v1/groupings: request fields and declared response contract.

GET/api/v1/groupings

Authorization
Permissionsettings.read
Workspace scoperequired
Scope targetworkspace

Response

200

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.axesarrayrequirednon-null—
data.totalnumberrequirednon-null—

Declared failures

Declared failures
GROUPING_LIST_FAILED500 — not retryable

Readback

This method returns the current state it read.

  • grouping.list

Request example

Schematic only. Replace placeholders with real values and include all required nested fields.

GET /api/v1/groupings HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>