Pular para o conteúdo
Formulários

Listar formulários

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

Os formulários de coleta do negócio (captação, qualificação, onboarding, pesquisa), com o link público e quantas respostas já receberam. Arquivados ficam de fora, salvo includeArchived=true. Paginado por cursor; limit até 50 (padrão 20) — mantenha o mesmo limit ao seguir o cursor.

Parâmetros de consulta

Vão na querystring, depois do ?.

  • qstringopcional
    • tamanho máx. 200
  • includeArchivedstringopcional
    • um de"true""false"
  • cursorstringopcional
  • limitintegeropcional
    • padrão 20
    • faixa 1–50

Respostas

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

200Deu certoapplication/json

Formulários do workspace, do editado mais recentemente para o mais antigo. nextCursor: null = acabou.

  • Cada item — V1Form

    • idstring
    • titlestring
    • descriptionstring | null
    • categorystring
    • publishedboolean
    • publishedVersioninteger | null
    • archivedboolean
    • publicUrlstring | null
    • responsesCountinteger
    • updatedAtstring
  • nextCursorstring | null

    Cursor opaco da PRÓXIMA página — passe em ?cursor=. null = acabou a lista.