---
title: "GET /api/v1/external-user-groups"
method: GET
path: "/api/v1/external-user-groups"
tags: ["External User Groups"]
---

# GET /api/v1/external-user-groups

`GET /api/v1/external-user-groups`

Retrieves multiple external user groups.

## Query parameters

- `externalId` string
- `ids` union
  - string[]
  - string, uuid — A UUID v4 string that identifies an entity.
- `pageNumber` number — The page number.
- `pageSize` number — The page size.
- `search` string — Search term to filter external user groups by name or external ids.
- `tierIds` union
  - string[]
  - string, uuid — A UUID v4 string that identifies an entity.

## Headers

- `authorization` string, required — The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

## Response `200`

Retrieves all external user groups for the workspace.

- object[]
  - `createdAt` string, date-time, required
  - `id` string, uuid, required — A UUID v4 string that identifies an entity.
  - `updatedAt` string, date-time, required
  - `externalId` string, nullable, required — External reference in the integrated system.
  - `name` string, nullable, required — The display name of the external user group.
  - `tierId` string, uuid, nullable, required — The tier associated with the external user group.
  - `workspaceId` string, uuid, required — The workspace that owns the external user group.

## Other responses

- `401` — Unauthorized.

---

[API](https://skmtc.dev/zaia/apis/public-api.md) · [All operations](https://skmtc.dev/zaia/apis/public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zaia/public-api/revisions/58da3b2ba49f/schema)