Buscar Modelo de Formulário de um Database

Retorna a estrutura completa do formulário utilizado na criação de registros de um Database (database register).

Este endpoint permite consultar todos os campos disponíveis no formulário relacionado a um campo do tipo databaseRegister, possibilitando integrações dinâmicas para criação, preenchimento e validação de registros.

As informações retornadas podem incluir identificadores dos campos, nomes, tipos e demais configurações do formulário vinculado ao Database.

É recomendado para integrações que necessitam montar formulários automaticamente ou identificar quais campos devem ser enviados na criação de registros.

Parâmetros utilizados

fieldInfoId

Identificador único do campo do tipo databaseRegister.

O valor deve ser informado diretamente na rota da requisição.

Exemplo:

GET https://api.goalfy.com.br/api/databaseRegisters/models/abcd-1234-efgh-5678

Neste exemplo:

abcd-1234-efgh-5678

Corresponde ao UUID do campo databaseRegister.

Exemplo de resposta

{
  "id": "10001",
  "name": "Cadastro de Clientes",
  "fields": [
    {
      "fieldInfoId": "aaaa-bbbb-cccc",
      "name": "Razão Social",
      "type": "text"
    },
    {
      "fieldInfoId": "dddd-eeee-ffff",
      "name": "Telefone",
      "type": "phone"
    },
    {
      "fieldInfoId": "gggg-hhhh-iiii",
      "name": "CNPJ",
      "type": "text"
    }
  ]
}

Observações

🚧

Importante

O retorno da requisição pode variar conforme as permissões do usuário autenticado e a configuração do formulário.

• Os campos retornados podem variar conforme a estrutura configurada no Database.
• O fieldInfoId deve obrigatoriamente pertencer a um campo do tipo databaseRegister.
• Alguns tipos de campo podem possuir estruturas específicas dependendo da configuração do formulário.
• Os identificadores retornados poderão ser utilizados posteriormente em endpoints de criação e atualização de registros.
• Recomenda-se armazenar os fieldInfoId para integrações dinâmicas.

FAQ?

Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas: