curl --request GET \
--url https://api.hubapi.com/marketing/v3/forms/{formId} \
--header 'Authorization: Bearer <token>'{
"id": "6eae0163-5362-4c0e-809c-b99a18678adc",
"name": "Register for updates",
"createdAt": "2020-09-22T05:12:27.505Z",
"updatedAt": "2020-09-22T07:17:31.627Z",
"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_group",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "firstname",
"label": "First name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
},
{
"objectTypeId": "0-1",
"name": "lastname",
"label": "Last name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
}
]
}
],
"configuration": {
"language": "en",
"cloneable": true,
"postSubmitAction": {
"type": "thank_you",
"value": "Thanks for submitting the form."
},
"editable": true,
"archivable": true,
"recaptchaEnabled": true,
"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": "explicit_consent_to_process",
"communicationConsentText": "<p>Fancy Forms, LLC is committed to protecting and respecting your privacy, and we’ll only use your personal information to administer your account and to provide the products and services you requested from us. From time to time, we would like to contact you about our products and services, as well as other content that may be of interest to you. If you consent to us contacting you for this purpose, please tick below to say how you would like us to contact you:</p>",
"communicationsCheckboxes": [
{
"required": false,
"subscriptionTypeId": 3883363,
"label": "<p>I agree to receive other communications from Fancy Forms, LLC.</p>"
}
],
"consentToProcessText": "<p>In order to provide you the content requested, we need to store and process your personal data. If you consent to us storing your personal data for this purpose, please tick the checkbox below.</p>",
"consentToProcessCheckboxLabel": "<p>I agree to allow Fancy Forms, LLC to store and process my personal data.</p>",
"privacyText": "<p>You can unsubscribe from these communications at any time. For more information on how to unsubscribe, our privacy practices, and how we are committed to protecting and respecting your privacy, please review our Privacy Policy.</p>"
},
"formType": "hubspot"
}Devuelve un formulario basado en el ID del formulario proporcionado.
curl --request GET \
--url https://api.hubapi.com/marketing/v3/forms/{formId} \
--header 'Authorization: Bearer <token>'{
"id": "6eae0163-5362-4c0e-809c-b99a18678adc",
"name": "Register for updates",
"createdAt": "2020-09-22T05:12:27.505Z",
"updatedAt": "2020-09-22T07:17:31.627Z",
"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_group",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "firstname",
"label": "First name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
},
{
"objectTypeId": "0-1",
"name": "lastname",
"label": "Last name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
}
]
}
],
"configuration": {
"language": "en",
"cloneable": true,
"postSubmitAction": {
"type": "thank_you",
"value": "Thanks for submitting the form."
},
"editable": true,
"archivable": true,
"recaptchaEnabled": true,
"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": "explicit_consent_to_process",
"communicationConsentText": "<p>Fancy Forms, LLC is committed to protecting and respecting your privacy, and we’ll only use your personal information to administer your account and to provide the products and services you requested from us. From time to time, we would like to contact you about our products and services, as well as other content that may be of interest to you. If you consent to us contacting you for this purpose, please tick below to say how you would like us to contact you:</p>",
"communicationsCheckboxes": [
{
"required": false,
"subscriptionTypeId": 3883363,
"label": "<p>I agree to receive other communications from Fancy Forms, LLC.</p>"
}
],
"consentToProcessText": "<p>In order to provide you the content requested, we need to store and process your personal data. If you consent to us storing your personal data for this purpose, please tick the checkbox below.</p>",
"consentToProcessCheckboxLabel": "<p>I agree to allow Fancy Forms, LLC to store and process my personal data.</p>",
"privacyText": "<p>You can unsubscribe from these communications at any time. For more information on how to unsubscribe, our privacy practices, and how we are committed to protecting and respecting your privacy, please review our Privacy Policy.</p>"
},
"formType": "hubspot"
}Productos compatibles
Ámbitos Requeridos
formsThe access token received from the authorization server in the OAuth 2.0 flow.
El identificador único del formulario
Si se quieren devolver solo los resultados que se han archivado.
successful operation
hubspot Show child attributes
Los campos de formulario incluidos en el grupo
A form field used for collecting an email address.
Show child attributes
Una lista de otros campos que se harán visibles en función del valor introducido en este campo.
Show child attributes
A condition based on customer input
Show child attributes
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.
Show child attributes
Una lista de otros campos que se harán visibles en función del valor introducido en este campo.
Determina cómo se mostrará y validará el campo.
phone Indica si un campo debe estar oculto o no. Los campos ocultos no aparecerán en el formulario, pero se pueden utilizar para pasar un valor a una propiedad sin necesidad de que el cliente lo introduzca.
La etiqueta principal para el campo del formulario.
El identificador del campo. En combinación con el ID del tipo de objeto, debe ser único.
Un ID único para el tipo de objeto CRM de este campo. Por ejemplo, un campo CONTACTO tendrá el ID de tipo de objeto 0-1.
Si se requiere un valor para este campo al enviar el formulario.
Decidir si se muestra un menú desplegable de código de país junto al campo de teléfono.
El valor introducido por opción predeterminada. Se enviará este valor a menos que el cliente lo modifique.
Texto adicional que ayuda al cliente a rellenar el campo.
El mensaje que aparece cuando no se rellena el campo.
Determina cómo se mostrará y validará el campo.
email Decidir si un campo debe estar oculto o no. Los campos ocultos no aparecerán en el formulario, pero se pueden utilizar para pasar un valor a una propiedad sin necesidad de que el cliente lo introduzca.
La etiqueta principal para el campo del formulario.
El identificador del campo. En combinación con el ID del tipo de objeto, debe ser único.
Un ID único para el tipo de objeto CRM de este campo. Por ejemplo, un campo CONTACTO tendrá el ID de tipo de objeto 0-1.
Decidir si se requiere un valor para este campo al enviar el formulario.
Describes how an email address should be validated.
El valor introducido por opción predeterminada. Este valor se enviará a menos que el cliente lo modifique.
Texto adicional que ayuda al cliente a rellenar el campo.
El mensaje que aparece cuando no se rellena el campo.
default_group, progressive, queued El tipo de texto enriquecido incluido. El valor predeterminado es texto.
image, text Un bloque de texto enriquecido o una imagen. Estos pueden utilizarse para añadir información adicional para los clientes que completan el formulario. Si el grupo de campos incluye campos, el texto enriquecido se mostrará antes de los campos.
Show child attributes
Decidir si se agrega un enlace de restablecimiento al formulario. Esto elimina cualquier contenido escrito previamente en el formulario y crea un nuevo contacto en el envío.
Decidir si el formulario puede archivarse.
Decidir si el formulario puede clonarse.
Decidir si se crea un nuevo contacto cuando se envíe un formulario con una dirección de correo electrónico que no coincide con ninguna en sus registros de contactos existentes.
Decidir si el formulario puede editarse.
El idioma del formulario.
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 Decidir si se envía un correo electrónico de notificación al propietario del contacto cuando se recibe una comunicación.
La lista de IDs de usuario que recibirán un correo electrónico de notificación cuando se reciba una comunicación.
What should happen after the customer submits the form.
Show child attributes
La acción a tomar después de enviar. La acción predeterminada es mostrar un mensaje de agradecimiento.
redirect_url, thank_you El texto de agradecimiento o la página a la que se redirigirá.
Decidir si los campos de contactos se rellenan previamente con información conocida cuando un contacto vuelve a tu sitio.
Decidir si CAPTCHA (prevención de spam) está activado.
Options for styling the form.
Show child attributes
Decidir si el formulario se mostrará como HTML sin formato en lugar de dentro de un iFrame.
Styling options for the form
Show child attributes
center, left, right El texto que aparece en el botón de envío del formulario.
El tema utilizado para dar estilo a los campos de entrada. Esto no se aplicará si el formulario se añade a una página CMS de HubSpot.
canvas, default_style, legacy, linear, round, sharp