---
title: "Listar grupos de usuários"
method: GET
path: "/{alias}/users/groups"
tags: ["Usuários - Grupos"]
---

# Listar grupos de usuários

`GET /{alias}/users/groups`

Lista os grupos de usuários da loja

## Path parameters

- `alias` string, required

## Response `200`

Lista dos grupos de usuários cadastrados

- object — Representa uma paginação com meta
  - `data` object — Agrupamento de usuários para gerenciar permissões em massa
    - `id` integer
    - `name` string — Nome do grupo de usuários
    - `default` boolean
    - `permissions` object
      - `data` UserPermission
        - `id` integer
        - `name` string
        - `code` integer
        - `translated_name` string
        - `created_at` BaseTimestamp
          - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
          - `timezone_type` integer — Número de representação do timezone.
          - `timezone` string — Fuso horário associado.
        - `updated_at` BaseTimestamp
          - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
          - `timezone_type` integer — Número de representação do timezone.
          - `timezone` string — Fuso horário associado.
    - `created_at` BaseTimestamp
      - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
      - `timezone_type` integer — Número de representação do timezone.
      - `timezone` string — Fuso horário associado.
    - `updated_at` BaseTimestamp
      - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
      - `timezone_type` integer — Número de representação do timezone.
      - `timezone` string — Fuso horário associado.
  - `meta` object
    - `pagination` object
      - `total` integer
      - `count` integer
      - `per_page` integer
      - `current_page` integer
      - `total_pages` integer
      - `links` object
        - `previous` string
        - `next` string

## Other responses

- `400` — Requisição inválida

---

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