Pular para o conteúdo

Buscar um formulário

GET
/forms/{id}
 
curl --request GET \
  --url https://dattacrm.com.br/api/v1/forms/0b6f3c1e-8a4d-4f5b-9c2e-1a2b3c4d5e6f \
  --header 'Authorization: Bearer <token>'

Devolve um formulário da conta pelo identificador, com etapas, tema, entrada no funil e os endereços publicUrl e embedUrl. Responde 404 quando o formulário não existe ou pertence a outra conta.

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Path Parameters

Seção intitulada “Path Parameters ”
id
required

Identificador do formulário.

string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
Example 
0b6f3c1e-8a4d-4f5b-9c2e-1a2b3c4d5e6f

Identificador do formulário.

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

Sucesso.

Media type application/json
object
data
required

Formulário de captação da conta, com as etapas, o tema e os endereços de uso.

object
id
required

Identificador do formulário.

string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required

Nome do formulário, como aparece no CRM.

string
slug
required

Apelido único do formulário na plataforma.

string
experience
required

Formato: classic (todas as perguntas numa página) ou conversational (uma pergunta por vez).

string
Allowed values: classic conversational
isActive
required

Publicado (true) ou desativado (false).

boolean
fields
required

Etapas do formulário, na ordem em que aparecem.

Array<object>

Uma etapa do formulário (id, type, title, crmField…).

object
key
additional properties
defaultTags
required

Tags aplicadas a todo lead que enviar o formulário.

Array<string>
defaultListId
required
Any of:

Identificador único (UUID).

string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
theme
required

Aparência do formulário (cores, fundo, tamanhos e alinhamento).

object
background
required

Cor de fundo, em hexadecimal de 6 dígitos (ex.: #202720).

string
default: #202720 /^#[0-9a-fA-F]{6}$/
foreground
required

Cor do texto, em hexadecimal de 6 dígitos.

string
default: #fbfaf6 /^#[0-9a-fA-F]{6}$/
accent
required

Cor de destaque (botões e seleção), em hexadecimal de 6 dígitos.

string
default: #1d8f7a /^#[0-9a-fA-F]{6}$/
bgType

Tipo do fundo: solid (cor única), linear, radial ou mesh (gradientes que usam bgColor2).

string
Allowed values: solid linear radial mesh
bgColor2

Segunda cor do gradiente de fundo, em hexadecimal de 6 dígitos.

string
/^#[0-9a-fA-F]{6}$/
fontFamily

Nome da fonte do formulário (até 50 caracteres).

string
<= 50 characters
fontSize

Tamanho geral da fonte: sm, md, lg ou xl.

string
Allowed values: sm md lg xl
questionSize
required

Tamanho do título das perguntas: small, medium (padrão) ou large.

string
default: medium
Allowed values: small medium large
answerSize
required

Tamanho do texto das respostas: small, medium (padrão) ou large.

string
default: medium
Allowed values: small medium large
alignment
required

Alinhamento do conteúdo: left (padrão) ou center.

string
default: left
Allowed values: left center
publicUrl
required

Endereço da página pública do formulário.

string
embedUrl
required

Endereço do código de incorporação (HTML) para colocar o formulário em outro site.

string
createdAt
required

Quando o formulário foi criado.

string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
updatedAt
required

Quando o formulário foi alterado pela última vez.

string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
Example 
{
  "data": {
    "id": "0b6f3c1e-8a4d-4f5b-9c2e-1a2b3c4d5e6f",
    "experience": "classic",
    "defaultListId": "0b6f3c1e-8a4d-4f5b-9c2e-1a2b3c4d5e6f",
    "theme": {
      "background": "#202720",
      "foreground": "#fbfaf6",
      "accent": "#1d8f7a",
      "bgType": "solid",
      "fontSize": "sm",
      "questionSize": "small",
      "answerSize": "small",
      "alignment": "left"
    },
    "createdAt": "2026-10-19T12:00:00.000Z",
    "updatedAt": "2026-10-19T12:00:00.000Z"
  }
}

Headers

Seção intitulada “Headers ”
X-Request-Id
string

Identificador da requisição, para suporte.

X-RateLimit-Limit
integer

Máximo de requisições por janela de 60 segundos para esta chave.

X-RateLimit-Remaining
integer

Requisições restantes na janela atual.

X-RateLimit-Reset
integer

Fim da janela atual, em milissegundos desde a época Unix (epoch ms).

400

Seção intitulada “400 ”

Dados inválidos na requisição (validation_error), lead novo sem lista (list_required), campo que mudou de lugar (field_moved) ou chave enviada na URL (api_key_in_url).

Media type application/json

Formato de erro da API.

object
error
required
object
code
required

Código estável do erro, ex.: validation_error.

string
message
required

Mensagem legível em português.

string
details

Detalhes extras, ex.: lista de campos inválidos.

requestId
required

Identificador da requisição, para suporte.

string
Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

Seção intitulada “Headers ”
X-Request-Id
string

Identificador da requisição, para suporte.

401

Seção intitulada “401 ”

Chave ausente, inválida (invalid_api_key), vencida (api_key_expired) ou revogada (api_key_revoked).

Media type application/json

Formato de erro da API.

object
error
required
object
code
required

Código estável do erro, ex.: validation_error.

string
message
required

Mensagem legível em português.

string
details

Detalhes extras, ex.: lista de campos inválidos.

requestId
required

Identificador da requisição, para suporte.

string
Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

Seção intitulada “Headers ”
X-Request-Id
string

Identificador da requisição, para suporte.

404

Seção intitulada “404 ”

Recurso não encontrado (not_found).

Media type application/json

Formato de erro da API.

object
error
required
object
code
required

Código estável do erro, ex.: validation_error.

string
message
required

Mensagem legível em português.

string
details

Detalhes extras, ex.: lista de campos inválidos.

requestId
required

Identificador da requisição, para suporte.

string
Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

Seção intitulada “Headers ”
X-Request-Id
string

Identificador da requisição, para suporte.

429

Seção intitulada “429 ”

Limite de requisições atingido (rate_limited). Aguarde Retry-After segundos.

Media type application/json

Formato de erro da API.

object
error
required
object
code
required

Código estável do erro, ex.: validation_error.

string
message
required

Mensagem legível em português.

string
details

Detalhes extras, ex.: lista de campos inválidos.

requestId
required

Identificador da requisição, para suporte.

string
Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

Seção intitulada “Headers ”
X-Request-Id
string

Identificador da requisição, para suporte.

X-RateLimit-Limit
integer

Máximo de requisições por janela de 60 segundos para esta chave.

X-RateLimit-Remaining
integer

Requisições restantes na janela atual.

X-RateLimit-Reset
integer

Fim da janela atual, em milissegundos desde a época Unix (epoch ms).

Retry-After
integer

Segundos até poder tentar de novo.

500

Seção intitulada “500 ”

Erro interno (internal_error). Informe o requestId ao suporte.

Media type application/json

Formato de erro da API.

object
error
required
object
code
required

Código estável do erro, ex.: validation_error.

string
message
required

Mensagem legível em português.

string
details

Detalhes extras, ex.: lista de campos inválidos.

requestId
required

Identificador da requisição, para suporte.

string
Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

Seção intitulada “Headers ”
X-Request-Id
string

Identificador da requisição, para suporte.