---
title: "List organization groups"
method: GET
path: "/api/v1/org/groups"
tags: ["Organizations"]
---

# List organization groups

`GET /api/v1/org/groups`

Gets all the groups in the current user's organization

## Query parameters

- `page` number, double
- `pageSize` number, double
- `includeMembers` number, double
- `searchQuery` string

## Response `200`

Ok

- ApiGroupListResponse
  - `results` KnexPaginatedDataGroupArrayOrGroupWithMembersArray, required
    - `pagination` object
      - `page` number, double, required
      - `pageSize` number, double, required
      - `totalResults` number, double, required
      - `totalPageCount` number, double, required
    - `data` union, required
      - Group[]
        - `organizationUuid` string, required — The UUID of the organization that the group belongs to
        - `updatedByUserUuid` string, nullable, required — The UUID of the user that last updated the group
        - `updatedAt` string, date-time, required — The time that the group was last updated
        - `createdByUserUuid` string, nullable, required — The UUID of the user that created the group
        - `createdAt` string, date-time, required — The time that the group was created
        - `name` string, required — A friendly name for the group
        - `uuid` string, required — The group's UUID
      - GroupWithMembers[]
        - `organizationUuid` string, required — The UUID of the organization that the group belongs to
        - `updatedByUserUuid` string, nullable, required — The UUID of the user that last updated the group
        - `updatedAt` string, date-time, required — The time that the group was last updated
        - `createdByUserUuid` string, nullable, required — The UUID of the user that created the group
        - `createdAt` string, date-time, required — The time that the group was created
        - `name` string, required — A friendly name for the group
        - `uuid` string, required — The group's UUID
        - `memberUuids` string[], required
        - `members` GroupMember[], required — A list of the group's members.
          - `lastName` string, required — The user's last name
          - `firstName` string, required — The user's first name
          - `email` string, required — Primary email address for the user
          - `userUuid` string, uuid, required — Unique id for the user
  - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.net/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.net/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/versions/40c933755c9a/schema)