Skip to main content
GET
Listar papéis

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

organization_id
string
obrigatório

Identificador da organização.

Required string length: 24
Pattern: ^[0-9a-f]{24}$

Parâmetros de consulta

page
integer
padrão:1

Número da página.

Intervalo obrigatório: x >= 1
per_page
integer
padrão:100

Número de elementos por página.

Intervalo obrigatório: 1 <= x <= 100
fields
string

Nomes dos campos do item de resposta, separados por vírgulas, a serem incluídos.

Maximum string length: 2048
filters
string

Expressão de filtros JSON sobre caminhos de campos filtráveis da resposta.

Maximum string length: 5120
sort
string

Expressão de orden no formato :asc|desc.

Pattern: ^(id|organization_id|name|created_at|created_by):(asc|desc)$

Resposta

Papéis recuperados com sucesso.

has_next
boolean
obrigatório

Indica se há outra página disponível.

data
object[]
obrigatório