Skip to main content
GET
cURL

Quando usar

Sempre antes de criar uma solicitação: o slug daqui é o que entra em template.
Use o slug, não o id. Ele é o endereço estável entre versões: publicar uma versão nova do modelo não quebra a sua integração.
Para montar um seletor no seu sistema, filtre com enabled=true: modelo desligado continua na listagem sem o filtro. scope separa os modelos da sua organização (ORGANIZATION) dos modelos GYRA+ (SYSTEM). Para ligar ou desligar um modelo, veja a Visão geral da API. Os modelos são montados no toolbox. Ver Solicitações de coleta.
Contexto e vocabulário em Solicitações de coleta. Autenticação, versionamento e capacidades em Visão geral da API.

Authorizations

Authorization
string
header
required

Enter JWT token

Query Parameters

Casa por nome ou pela chave, sem acento e sem caixa.

Maximum string length: 120
scope
enum<string>

ORGANIZATION (modelos da sua organizacao) ou SYSTEM (modelos GYRA+). Sem o parametro, os dois.

Available options:
ORGANIZATION,
SYSTEM
enabled
boolean

true devolve so os modelos ligados. Sem o parametro (ou com false), ligados e desligados.

itemKind
string[]

So modelos que pedem itens destes tipos (DOCUMENT, FORM, SIGNATURE, CONSENT, IDENTITY, CUSTOM). Repita para varios.

skip
number
take
number
Required range: x <= 100

Response

Modelos com slug, nome, descricao, itens e uso.

items
object[]
total
integer