Listar grupos

Em teste

Develop Env

https://api-develop.enspace.io

GET

/ws/member-groups

Responsável:Julio Cordeiro

Listar Grupos

Retorna uma lista de grupos vinculados ao workspace atual. Inclui informações detalhadas como nome, status, quantidade de membros e usuários associados.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api-develop.enspace.io/ws/member-groups?__relations=users' \
--header 'x-api-key;' \
--header 'en-workspace;'

Response Example

200 - Example 1

{
    "id": 12,
    "name": "Nome do Grupo",
    "description": "Descrição",
    "status": "active",
    "owner_group": {
        "id": 8,
        "name": "abc",
        "reference": "abc",
        "status": "active",
        "description": "Descrição",
        "icon": "tabler:address-book",
        "modules": {
            "comparisons": true,
            "monetary_correction": false
        },
        "config": 8,
        "created_at": "2025-06-20T18:35:36.342Z",
        "updated_at": "2025-06-25T17:29:11.520Z"
    },
    "created_at": "2025-06-30T18:44:47.827Z",
    "updated_at": "2025-06-30T18:50:44.096Z",
    "slug": "Nome do Grupo",
    "users": [
        {
            "id": 23,
            "username": "example.ex@hotmail.com",
            "email": "example.ex@hotmail.com",
            "provider": "local",
            "language": "en",
            "meta": {
                "fname": "example",
                "lname": "ex"
            },
            "created_at": "2025-06-26T15:16:32.255Z",
            "updated_at": "2025-06-26T15:16:32.255Z"
        }
    ]
}

Requisição

Authorization

API Key

Adicionar parâmetro em header

x-api-key

Exemplo:

x-api-key: ********************

API Key

Adicionar parâmetro em header

en-workspace

Exemplo:

en-workspace: ********************

Parâmetros Query

__relations

string | null

opcional

Faz com que o retorna inclua a lista de usuários no grupo.

Exemplo:

users

Respostas

🟢200OK

application/json

Sucesso. Retorna a lista de grupos

Body

array of:

integer

requerido

name

string

requerido

Nome do Grupo de Membros.

created_at

string

requerido

updated_at

string

requerido

members_count

integer

requerido

Contador de membros.

slug

string

requerido

Slug unico baseado no nome do grupo.

users

array[object (User) {4}]

opcional

Lista de usuários que estao no grupo de membros.

integer

requerido

ID do do registro

created_at

string

requerido

Data em que o registro foi criado

string

requerido

Email do Usuário

Listar grupos

Listar Grupos#

Requisição

Respostas

Listar Grupos