---
title: "Get a group"
method: GET
path: "/v1/groups/{group}"
tags: ["Groups"]
---

# Get a group

`GET /v1/groups/{group}`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/groups/{group}`
- Auth: HTTP bearer

One group with its `permissions` and `member_ids`, which are returned when the group is read individually or after a write and omitted from list responses so a listing stays one query.

## Path parameters

- `group` string, uuid, required

## Response `200`

The group resource.

- object
  - `data` GroupResource, required: A group: a named permission bundle a team shares between several collaborators, each of whom may be in several groups.
    - `id` string, required: The group's id.
    - `team_id` string, nullable, required: The team the group belongs to.
    - `code` string, required: The machine name, unique within the team and immutable after creation, because permissions are addressed by it.
    - `name` string, required: The display name.
    - `permissions` string[]: The permission codes the group grants. Returned when the group is read individually or after a write, omitted from list responses so a listing stays one query.
    - `member_ids` string[]: The users in the group. Returned after a member sync, omitted elsewhere.
    - `created_at` string, nullable, required: When the group was created, ISO 8601.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)