Formulários · API Reference · Developers

Listar formulários

Retorna todos os formulários da organização do chamador (arquivados excluídos por padrão). Suporta filtragem por escopo, proprietário, busca por nome, ordenação por nome/data/total de respostas, intervalos de data e inclusão opcional de perguntas. As capacidades — edição, visibilidade de respostas, mudanças de estado — são governadas pelas permissões do formulário; o proprietário e os administradores sempre têm acesso completo.

{
  "count": "integer",
  "next": "string | null",
  "previous": "string | null",
  "results": "array<{ uuid, name, is_active, collect_responses_anonymously, privacy, shortcut, start_on, end_on, is_archived, workflow_enabled, approval_flow_enabled, created_at, questions? }>"
}

curl -sS 'https://api.dailybot.com/v1/forms/?filter=workflow&order=alphabetical&is_ascend=true' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

• Quando include=questions está configurado, cada objeto de formulário inclui um array questions com UUID, label, type, flag required e options de cada pregunta.
• Obsoleto: filter=me — use owner_user_ids com seu próprio UUID de usuário. Clientes legados continuam funcionando: me ainda resolve para o escopo do proprietário do chamador e intersecta com qualquer owner_user_ids explícito. O escopo me em endpoints de respostas de formulário não está relacionado e NÃO está obsoleto. Tanto filter=me quanto available_on_list_view continuam sendo aceitos indefinidamente; a remoção será anunciada como uma entrada de changelog separada com sua própria janela de migração.
• Obsoleto: available_on_list_view — ainda aceito em POST /v1/forms/create/ e PATCH /v1/forms/{uuid}/config/ mas ignorado no servidor. A visibilidade na lista agora é organizacional. Para ocultar um formulário, arquive-o.

Listar proprietários de formulários

Seletor paginado e pesquisável de membros da organização que possuem pelo menos um formulário não arquivado. Apenas membros ativos e aprovados aparecem. Ordenado por full_name ascendente. Projetado para seletores de UI: uma organização de 1000 membros retorna apenas seus (tipicamente poucos) proprietários de formulários, não todo o diretório.

{
  "count": "integer",
  "next": "string | null",
  "previous": "string | null",
  "results": "array<{ uuid, full_name, image, role, email (conditional — present only for admin/manager/team-admin-scoped callers) }>"
}

curl -sS 'https://api.dailybot.com/v1/forms/form-owners/?search=serg&limit=20' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

• Os emails dos membros estão ocultos nos payloads do seletor. O campo email aparece APENAS quando o chamador tem visibilidade de email — admins da organização, managers e admins de equipe. Chamadores com escopo de membro recebem linhas sem a chave email (omitida, nunca null). API keys herdam o papel do proprietário da chave. search ainda corresponde ao email no servidor para todos, mas o valor nunca é retornado para chamadores sem visibilidade.
• O campo role contém o slug do papel organizacional: ADMIN_ORG, MANAGER, ADMIN, MEMBER ou GUEST.

Obter um formulário

Obtém um formulário por UUID. A porta de leitura é a membresía organizacional — qualquer membro autenticado da organização pode ler qualquer formulário. Os campos privacy e available_on_list_view não afetam quem pode ler o formulário; as capacidades como editar, ver respostas e mudar estados de workflow são governadas pelas permissões por escopo do formulário (o proprietário e os admins sempre têm acesso completo).

{
  "uuid": "string (uuid)",
  "name": "string",
  "is_active": "boolean",
  "collect_responses_anonymously": "boolean",
  "privacy": "string",
  "questions": "array",
  "workflow": "object",
  "created_at": "string (ISO 8601)"
}

curl -sS -X GET 'https://api.dailybot.com/v1/forms/{uuid}/' -H 'X-API-KEY: $DAILYBOT_API_KEY'

• A porta de leitura do detalhe é a membresía organizacional. O campo privacy reflete o escopo de envio do formulário (OWNER, TEAM, EVERYONE), não quem pode ler a definição do formulário. O campo available_on_list_view está obsoleto e não tem efeito — todos os formulários da organização agora aparecem no endpoint de lista.

Listar respostas de um formulário

Lista paginada de respostas do formulário. Por padrão retorna apenas as respostas do chamador. Com all=true ou qualquer filtro avançado (submission_sources, submitter_user_ids, flow_status), retorna todas as respostas e requer permissão VIEW_REPORTS. Suporta busca de texto completo, filtragem por origem de envio, estado de workflow, estado de aprovação, intervalos de data e ordenação.

{
  "count": "integer",
  "next": "string | null",
  "previous": "string | null",
  "results": "array<{ uuid, user, is_dailybot_bot, is_guest_user, is_anonymous, guest_user, submission_source, flow_status, current_state, content, response_completed, has_issue, created_at, updated_at }>"
}

curl -sS 'https://api.dailybot.com/v1/forms/{uuid}/responses/?all=true&submission_sources=automation,public&order=recent' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

• Todos os filtros se compõem com AND entre grupos e OR dentro de cada grupo. Exemplo: submission_sources=member,automation AND flow_status=pending retorna respostas de membros OU automação que estão pendentes de aprovação.
• Usar qualquer filtro avançado (submission_sources, submitter_user_ids, flow_status) implica automaticamente all=true e requer permissão VIEW_REPORTS.

Obter uma resposta de formulário

Obtém uma resposta de formulário identificada por uuid. Retorna current_state, allowed_transitions e content.

{
  "uuid": "string (uuid)",
  "form": "string (uuid)",
  "content": "array",
  "current_state": "string",
  "allowed_transitions": "array<string>",
  "response_completed": "boolean",
  "has_issue": "boolean",
  "blockers_status": "string | null",
  "is_anonymous": "boolean",
  "is_dailybot_bot": "boolean",
  "is_guest_user": "boolean",
  "guest_user": "object | null — { full_name, email }",
  "submission_source": "string | null",
  "flow_status": "string | null — approval status: approved, denied, or null (pending/no flow)",
  "created_at": "string (ISO 8601)",
  "updated_at": "string (ISO 8601)"
}

curl -sS -X GET 'https://api.dailybot.com/v1/forms/{uuid}/responses/{response_uuid}/' -H 'X-API-KEY: $DAILYBOT_API_KEY'