List groups

Get a list of groups within an organization

GET /api/v1/scim/v2/Groups

Error

A valid request URL is required to generate request examples

200

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 1,
  "itemsPerPage": 1,
  "startIndex": 1,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "id": "1456c265-f375-4d64-bd33-105c84ad9b5d",
      "displayName": "Org 1 Editor Group",
      "members": [
        {
          "value": "80fb8b59-d6b7-4ed6-b969-9849310f3e53",
          "display": "[e-mail]"
        }
      ],
      "meta": {
        "resourceType": "Group",
        "created": "2025-11-03T14:22:24.067Z",
        "lastModified": "2025-11-03T14:22:24.067Z",
        "location": "https://<tenant>.lightdash.cloud/api/v1/scim/v2/Groups/1456c265-f375-4d64-bd33-105c84ad9b5d"
      }
    }
  ]
}

Query Parameters

filter · string

Filter to apply to the group list (optional)

startIndex · number<double>

Index of the first group to return (optional)

count · number<double>

Number of groups to return (optional)

Response

200 - application/json

Ok

schemas · enum<string>[] · required

Available options: urn:ietf:params:scim:api:messages:2.0:ListResponse

totalResults · number<double> · required

itemsPerPage · number<double> · required

startIndex · number<double> · required

Resources · object[] · required

Show child attributes