Listar um Registro Específico

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retorna todas as informações de um registro específico utilizando seu identificador único (idRegistro).

Este endpoint permite consultar os dados completos de um registro dentro da plataforma, incluindo campos preenchidos, valores armazenados, informações do formulário e demais dados relacionados ao registro consultado.

É recomendado para integrações que necessitam acessar informações detalhadas de registros específicos para sincronização, consultas externas ou automações.


Parâmetros utilizados

idRegistro

Identificador único do registro que será consultado.

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

Exemplo:

GET https://api.goalfy.com.br/api/forms/12345

Neste exemplo:

12345

Corresponde ao ID do registro consultado.


Exemplo de resposta

{
  "id": "12345",
  "title": "Goalfy",
  "createdAt": "2026-06-03T10:00:00Z",
  "fields": [
    {
      "name": "Razão Social",
      "value": "Goalfy"
    },
    {
      "name": "Telefone",
      "value": "+55 11 99999-9999"
    }
  ]
}

✅

Respostas esperadas

Sucesso 200

Retorna todas as informações relacionadas ao registro solicitado.


❗

Possíveis erros

404 Not Found

Retornado quando o registro informado não existe ou não foi localizado.

401 Unauthorized

Retornado quando o token de autenticação é inválido ou não foi enviado corretamente.

403 Forbidden

Retornado quando o usuário não possui permissão para acessar o registro informado.


Observações

🚧

Importante

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

  • Alguns campos podem retornar valores nulos dependendo da configuração do formulário.
  • O conteúdo retornado pode variar conforme os tipos de campo utilizados no registro.
  • Recomenda-se validar o ID do registro antes de realizar integrações automatizadas.
  • O idRegistro deve corresponder a um registro válido existente na plataforma.

FAQ?

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

Path Params
string
required
Defaults to {idRegistro}
Headers
string
required
Defaults to "Token YOUR_TOKEN"
Response
200
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!