Skip to navigation
API ReferenceAgent Groups

List agent groups

Lista os grupos de agentes.

Suporta os parâmetros universais JSON:API (paginação, ordenação, include, sparse fieldsets) — veja as convenções.

Authentication

AuthorizationBearer
Token de API da conta do tenant.

Query parameters

filter[name]stringOptional

string, opcional. Retorna apenas grupos cujo nome seja igual ao valor.

Ex: filter[name]=Vendas

includestringOptional

Relacionamentos incluíveis: agents (use include=agents para trazer os dados dos agentes do grupo).

sortstringOptional

Ordenável por: name (sort=name ou sort=-name).

page[limit]stringOptional

integer, opcional. Quantidade máxima de itens por página.

page[offset]stringOptional

integer, opcional. Deslocamento (quantos itens pular) para paginação.

Response

Sucesso.