---
title: "Gets a list of all Group resources"
method: GET
path: "/api/v1/groups/"
tags: ["Groups"]
---

# Gets a list of all Group resources

`GET /api/v1/groups/`

## Query parameters

- `search` string
- `index` integer
- `pageLength` integer

## Headers

- `X-Fields` string, mask

## Response `200`

Success

- GroupPage
  - `index` integer — Starting index of the current page.
  - `isComplete` boolean — Boolean indicating if more data is available.
  - `totalNumResults` integer — Total number of results.
  - `first` string — URL to first page in results set.
  - `next` string — URL to next page in results set.
  - `prev` string — URL to last page in results set.
  - `data` GroupDump[]
    - `name` string, required — Name of the Group.
    - `id` integer — ID for the Group resource.
    - `user` UserRefDump
      - `id` integer — ID for the User resource.
      - `username` string — Username of the User resource.
      - `url` string — URL for accessing the full User resource.
    - `members` GroupMemberDump[]
      - `user` UserRefDump
        - `id` integer — ID for the User resource.
        - `username` string — Username of the User resource.
        - `url` string — URL for accessing the full User resource.
      - `group` GroupRef
        - `id` integer — ID for the Group resource.
        - `name` string — Name of the Group resource.
        - `url` string — URL for accessing the full Group resource.
      - `permissions` GeneratedDump
        - `read` boolean — Permission for member to read Group.
        - `write` boolean — Permission for member to modify Group.
        - `shareRead` boolean — Permission for member to share read-only Group.
        - `shareWrite` boolean — Permission for member to share read+write Group.
        - `owner` boolean — Flag for if the member is a Group owner.
        - `admin` boolean — Flag for if the member is a Group admin.
    - `createdOn` string, date-time — Timestamp when the Group resource was created.
    - `lastModifiedOn` string, date-time — Timestamp when the Group resource was last modified.

---

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