curl --request GET \
--url https://api.hubapi.com/marketing/v3/forms/ \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": "b6336282-50ec-465e-894e-e368146fa25f",
"name": "Contact us",
"createdAt": "2020-09-22T05:15:12.311Z",
"updatedAt": "2020-09-22T05:15:35.361Z",
"archived": false,
"fieldGroups": [
{
"groupType": "default_group",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "email",
"label": "Email",
"required": true,
"hidden": false,
"fieldType": "email",
"validation": {
"blockedEmailDomains": [],
"useDefaultBlockList": false
}
}
]
},
{
"groupType": "default",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "firstname",
"label": "First name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
}
]
},
{
"groupType": "default",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "lastname",
"label": "Last name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
}
]
},
{
"groupType": "default",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "message",
"label": "Message",
"required": false,
"hidden": false,
"fieldType": "multi_line_text"
}
]
}
],
"configuration": {
"language": "en",
"cloneable": true,
"postSubmitAction": {
"type": "thank_you",
"value": "Thanks for submitting the form."
},
"editable": true,
"archivable": true,
"recaptchaEnabled": false,
"notifyContactOwner": false,
"notifyRecipients": [
"2886602"
],
"createNewContactForNewEmail": false,
"prePopulateKnownValues": true,
"allowLinkToResetKnownValues": false,
"lifecycleStages": [
{
"objectTypeId": "0-1",
"value": "subscriber"
},
{
"objectTypeId": "0-2",
"value": "subscriber"
}
]
},
"displayOptions": {
"renderRawHtml": false,
"theme": "default_style",
"submitButtonText": "Submit",
"style": {
"fontFamily": "arial, helvetica, sans-serif",
"backgroundWidth": "100%",
"labelTextColor": "#33475b",
"labelTextSize": "13px",
"helpTextColor": "#7C98B6",
"helpTextSize": "11px",
"legalConsentTextColor": "#33475b",
"legalConsentTextSize": "14px",
"submitColor": "#ff7a59",
"submitAlignment": "left",
"submitFontColor": "#ffffff",
"submitSize": "12px"
},
"cssClass": "hs-form stacked"
},
"legalConsentOptions": {
"type": "none"
},
"formType": "hubspot"
},
{
"id": "c7cd13be-3024-4bc8-8582-4a87678b5acc",
"name": "Pop-up form: Sign up now popup",
"formType": "flow",
"createdAt": "2020-09-22T05:19:42.276Z",
"updatedAt": "2020-09-22T05:20:29.356Z",
"archived": false
},
{
"id": "ad4497f3-b80a-4369-a7d0-cade0e4c202d",
"name": "Collected form: .visitorRegistration",
"formType": "captured",
"createdAt": "2020-09-22T05:18:40.533Z",
"updatedAt": "2020-09-22T05:18:40.533Z",
"archived": false
}
],
"paging": {
"next": {
"after": "Mw%3D%3D",
"link": "https://api.hubspot.com/marketing/v3/forms?portalId=103268800&limit=3&formTypes=ALL&hs_static_app=api-goggles&hs_static_app_version=1.4854&after=Mw%3D%3D"
}
}
}Retorna uma lista de formulários com base nos filtros de pesquisa. Por padrão, retorna os primeiros 20 formulários “hubspot”.
curl --request GET \
--url https://api.hubapi.com/marketing/v3/forms/ \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": "b6336282-50ec-465e-894e-e368146fa25f",
"name": "Contact us",
"createdAt": "2020-09-22T05:15:12.311Z",
"updatedAt": "2020-09-22T05:15:35.361Z",
"archived": false,
"fieldGroups": [
{
"groupType": "default_group",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "email",
"label": "Email",
"required": true,
"hidden": false,
"fieldType": "email",
"validation": {
"blockedEmailDomains": [],
"useDefaultBlockList": false
}
}
]
},
{
"groupType": "default",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "firstname",
"label": "First name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
}
]
},
{
"groupType": "default",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "lastname",
"label": "Last name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
}
]
},
{
"groupType": "default",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "message",
"label": "Message",
"required": false,
"hidden": false,
"fieldType": "multi_line_text"
}
]
}
],
"configuration": {
"language": "en",
"cloneable": true,
"postSubmitAction": {
"type": "thank_you",
"value": "Thanks for submitting the form."
},
"editable": true,
"archivable": true,
"recaptchaEnabled": false,
"notifyContactOwner": false,
"notifyRecipients": [
"2886602"
],
"createNewContactForNewEmail": false,
"prePopulateKnownValues": true,
"allowLinkToResetKnownValues": false,
"lifecycleStages": [
{
"objectTypeId": "0-1",
"value": "subscriber"
},
{
"objectTypeId": "0-2",
"value": "subscriber"
}
]
},
"displayOptions": {
"renderRawHtml": false,
"theme": "default_style",
"submitButtonText": "Submit",
"style": {
"fontFamily": "arial, helvetica, sans-serif",
"backgroundWidth": "100%",
"labelTextColor": "#33475b",
"labelTextSize": "13px",
"helpTextColor": "#7C98B6",
"helpTextSize": "11px",
"legalConsentTextColor": "#33475b",
"legalConsentTextSize": "14px",
"submitColor": "#ff7a59",
"submitAlignment": "left",
"submitFontColor": "#ffffff",
"submitSize": "12px"
},
"cssClass": "hs-form stacked"
},
"legalConsentOptions": {
"type": "none"
},
"formType": "hubspot"
},
{
"id": "c7cd13be-3024-4bc8-8582-4a87678b5acc",
"name": "Pop-up form: Sign up now popup",
"formType": "flow",
"createdAt": "2020-09-22T05:19:42.276Z",
"updatedAt": "2020-09-22T05:20:29.356Z",
"archived": false
},
{
"id": "ad4497f3-b80a-4369-a7d0-cade0e4c202d",
"name": "Collected form: .visitorRegistration",
"formType": "captured",
"createdAt": "2020-09-22T05:18:40.533Z",
"updatedAt": "2020-09-22T05:18:40.533Z",
"archived": false
}
],
"paging": {
"next": {
"after": "Mw%3D%3D",
"link": "https://api.hubspot.com/marketing/v3/forms?portalId=103268800&limit=3&formTypes=ALL&hs_static_app=api-goggles&hs_static_app_version=1.4854&after=Mw%3D%3D"
}
}
}Produtos suportados
Escopos Necessários
The access token received from the authorization server in the OAuth 2.0 flow.
O token do cursor de paginação do último recurso lido com sucesso será retornado como a propriedade JSON "paging.next.after" de uma resposta paginada que contém mais resultados.
Se apenas os resultados que foram arquivados devem ser retornados.
Os tipos de formulário a serem incluídos nos resultados.
hubspot, captured, flow, blog_comment, all O número máximo de resultados a serem exibidos por página.
successful operation
Mostrar atributos filhos
hubspot Mostrar atributos filhos
Os campos de formulário incluídos no grupo
A form field used for collecting an email address.
Mostrar atributos filhos
Uma lista de outros campos a serem exibidos com base no valor preenchido para este campo.
Mostrar atributos filhos
A condition based on customer input
Mostrar atributos filhos
between, contains, doesnt_contain, eq, gt, gte, is_not_empty, lt, lte, neq, not_between, set_all, set_any, set_eq, set_neq, set_not_all, set_not_any, str_ends_with, str_starts_with, within_time, within_time_reverse A form field used for collecting a phone number.
Mostrar atributos filhos
Uma lista de outros campos a serem exibidos com base no valor preenchido para este campo.
Determina como o campo será exibido e validado.
phone Se um campo deve ser ocultado ou não. Campos ocultos não aparecerão no formulário, mas podem ser usados para transmitir um valor a uma propriedade sem exigir que o cliente o preencha.
O rótulo principal do campo do formulário.
O identificador do campo. Em combinação com o ID do tipo de objeto, ele deve ser exclusivo.
Um ID exclusivo para o tipo de objeto do CRM deste campo. Por exemplo, um campo de CONTACT terá o ID de tipo de objeto 0-1.
Se um valor para este campo é necessário ao enviar o formulário.
Se um menu suspenso de código de país deve ser exibido ao lado do campo de telefone.
O valor preenchido por padrão. Este valor será enviado, a menos que o cliente o modifique.
Texto adicional que ajuda o cliente a preencher o campo.
O texto de prompt exibido quando o campo não está preenchido.
Determina como o campo será exibido e validado.
email Se um campo deve ser ocultado ou não. Campos ocultos não aparecerão no formulário, mas podem ser usados para transmitir um valor a uma propriedade sem exigir que o cliente o preencha.
O rótulo principal do campo do formulário.
O identificador do campo. Em combinação com o ID do tipo de objeto, ele deve ser exclusivo.
Um ID exclusivo para o tipo de objeto do CRM deste campo. Por exemplo, um campo de CONTACT terá o ID de tipo de objeto 0-1.
Se um valor para este campo é necessário ao enviar o formulário.
Describes how an email address should be validated.
O valor preenchido por padrão. Este valor será enviado, a menos que o cliente o modifique.
Texto adicional que ajuda o cliente a preencher o campo.
O texto de prompt exibido quando o campo não está preenchido.
default_group, progressive, queued O tipo de rich text incluído. O valor padrão é texto.
image, text Um bloco de rich text ou uma imagem. Podem ser usados para adicionar informações extras para os clientes que preenchem o formulário. Se o grupo de campos incluir campos, o rich text será exibido antes dos campos.
Mostrar atributos filhos
Se um link de redefinição deve ser adicionado ao formulário. Remove qualquer conteúdo preenchido previamente no formulário e cria um novo contato ao enviar.
Se o formulário pode ser arquivado.
Se o formulário pode ser clonado.
Se um novo contato deve ser criado quando um formulário é enviado com um endereço de e-mail que não corresponde a nenhum endereço em seus registros de contato existentes.
Se o formulário pode ser editado.
O idioma do formulário.
af, ar-eg, bg, bn, ca-es, cs, da, de, el, en, es, es-mx, fi, fr, fr-ca, he-il, hr, hu, id, it, ja, ko, lt, ms, nl, no-no, pl, pt, pt-br, ro, ru, sk, sl, sv, th, tl, tr, uk, vi, zh-cn, zh-hk, zh-tw Se um e-mail de notificação deve ser enviado ao proprietário do contato quando um envio é recebido.
A lista de IDs de usuários para receber um e-mail de notificação quando um envio for recebido.
What should happen after the customer submits the form.
Mostrar atributos filhos
A ação a ser tomada após o envio. A ação padrão é exibir uma mensagem de agradecimento.
redirect_url, thank_you O texto de agradecimento ou a página à qual redirecionar.
Se os campos de contato devem ser preenchidos previamente com informações conhecidas quando um contato retorna ao seu site.
Se o CAPTCHA (prevenção de spam) está habilitado.
Options for styling the form.
Mostrar atributos filhos
Se o formulário será renderizado como HTML bruto em vez de dentro de um iFrame.
Styling options for the form
Mostrar atributos filhos
center, left, right O texto exibido no botão de envio do formulário.
O tema usado para estilizar os campos de entrada. Não se aplicará se o formulário for adicionado a uma página do HubSpot CMS.
canvas, default_style, legacy, linear, round, sharp Mostrar atributos filhos