Axuz Developers

GET /teams/{teamId}/user-groups/

Lista grupos do team (qualquer membro le)

  • Acesso: Membro da equipe
  • Serviço: https://api-workspace.axuz.net

Autenticação aceita

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

200 {items} com member_ids. Onde: pickers de grupo e tela de setores.

listUserGroupsHandler — GET /teams/{t}/user-groups.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim

Respostas

200

ok

NomeTipoObrigatórioDescrição
itemsarray<UserGroup>sim
items[].idstring<uuid>sim
items[].team_idstring<uuid>sim
items[].namestringsim
items[].colorstringsim

token da paleta fechada (slate gray red orange amber yellow lime green teal cyan blue indigo violet purple pink rose) ou hex #RRGGBB (normalizado para minusculas)

items[].iconstring | nullsim
items[].member_idsarray<string<uuid>>sim
items[].created_bystring<uuid>sim
items[].created_atstring<date-time>sim
items[].updated_atstring<date-time>sim

401

sem sessao

403

nao e membro do team (ou membro de outro tenant)

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X GET 'https://api-workspace.axuz.net/teams/TEAM_ID/user-groups/' \
  -H "Authorization: Bearer $AXUZ_TOKEN"

Node.js

const res = await fetch("https://api-workspace.axuz.net/teams/TEAM_ID/user-groups/", {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "GET",
    "https://api-workspace.axuz.net/teams/TEAM_ID/user-groups/",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())