Pular para o conteúdo
Formulários

Buscar resposta de formulário por id

v1.0.0
GEThttps://api.growthaisystem.com/api/v1/forms/{id}/responses/{responseId}
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposforms.read

Os rótulos são os da VERSÃO que a pessoa respondeu (o formulário pode ter mudado depois). Contato na Lixeira não sai: contactId, contactName e contactPhone vêm nulos; o que a pessoa digitou (items) fica como foi respondido.

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

  • idstringobrigatório
    • tamanho 1–64
  • responseIdstringobrigatório
    • tamanho 1–64

Respostas

6 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

A resposta inteira: cada pergunta da versão respondida, com o rótulo de então e o texto completo.

V1FormResponseDetail

  • idstring
  • formIdstring
  • receivedAtstring
  • statusstring
    • um de"submitted""partial"
  • originstring
    • um de"public""internal"
  • versioninteger
  • respondedByUserIdstring | null
  • contactIdstring | null
  • contactNamestring | null
  • contactPhonestring | null
  • hiddenstring[]
    • sourcestring | null
    • mediumstring | null
    • campaignstring | null
    • termstring | null
    • contentstring | null
    • statestring
      • um de"agendado""pendente""sem_horario"
    • startAtstring | null
    • endAtstring | null

  • Cada item da lista

    • namestring
    • labelstring
    • typestring
    • valuestring
    • shownboolean
  • consentTextstring | null
  • consentedAtstring | null
  • appointmentIdstring | null