Citas
Asociaciones v3
Esquema de Asociaciones v3
Asociaciones v4
Esquema de Asociaciones v4
Carritos
NEWPagos de Commerce
Suscripciones de Commerce
Empresas
Contactos
Cursos
Objetos personalizados
Negocios
Descuentos
Exportaciones
Tarifas
Metas
NEWImportaciones
Facturas
Leads
Elementos de pedido
Fichas
Objetos
Pedidos
NEWPropietarios
Clientes de partners
Servicios de partners
Pipelines
Productos
Proyectos
Propiedades
Validación de propiedades
Cotizaciones
Servicios
Impuestos
Tickets
Comunicaciones
Divisiones de negocios
Envíos de comentarios
Seguimiento de límites
Biblioteca de objetos
Esquemas
curl --request POST \
--url https://api.hubapi.com/crm/v3/properties/{objectType}/batch/read \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"archived": true,
"dataSensitivity": "highly_sensitive",
"inputs": [
{
"name": "my_custom_property"
}
]
}
'{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"displayOrder": 2,
"fieldType": "select",
"formField": true,
"groupName": "contactinformation",
"hasUniqueValue": false,
"hidden": false,
"label": "My Contact Property",
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": false,
"readOnlyOptions": false,
"readOnlyValue": false
},
"name": "my_contact_property",
"options": [
{
"description": "Choice number one",
"displayOrder": 1,
"hidden": false,
"label": "Option A",
"value": "A"
},
{
"description": "Choice number two",
"displayOrder": 2,
"hidden": false,
"label": "Option B",
"value": "B"
}
],
"type": "enumeration"
}
],
"startedAt": "2023-11-07T05:31:56Z",
"status": "CANCELED",
"errors": [
{
"category": "<string>",
"context": {},
"errors": [
{
"message": "<string>",
"code": "<string>",
"context": "{missingScopes=[scope1, scope2]}",
"in": "<string>",
"subCategory": "<string>"
}
],
"links": {},
"message": "<string>",
"status": "<string>",
"id": "<string>",
"subCategory": {}
}
],
"links": {},
"numErrors": 123,
"requestedAt": "2023-11-07T05:31:56Z"
}Leer un lote de propiedades
Lee una lista especificada de propiedades.
curl --request POST \
--url https://api.hubapi.com/crm/v3/properties/{objectType}/batch/read \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"archived": true,
"dataSensitivity": "highly_sensitive",
"inputs": [
{
"name": "my_custom_property"
}
]
}
'{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"displayOrder": 2,
"fieldType": "select",
"formField": true,
"groupName": "contactinformation",
"hasUniqueValue": false,
"hidden": false,
"label": "My Contact Property",
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": false,
"readOnlyOptions": false,
"readOnlyValue": false
},
"name": "my_contact_property",
"options": [
{
"description": "Choice number one",
"displayOrder": 1,
"hidden": false,
"label": "Option A",
"value": "A"
},
{
"description": "Choice number two",
"displayOrder": 2,
"hidden": false,
"label": "Option B",
"value": "B"
}
],
"type": "enumeration"
}
],
"startedAt": "2023-11-07T05:31:56Z",
"status": "CANCELED",
"errors": [
{
"category": "<string>",
"context": {},
"errors": [
{
"message": "<string>",
"code": "<string>",
"context": "{missingScopes=[scope1, scope2]}",
"in": "<string>",
"subCategory": "<string>"
}
],
"links": {},
"message": "<string>",
"status": "<string>",
"id": "<string>",
"subCategory": {}
}
],
"links": {},
"numErrors": 123,
"requestedAt": "2023-11-07T05:31:56Z"
}Productos compatibles
Productos compatibles
Marketing Hub -Gratuito
Sales Hub -Gratuito
Service Hub -Gratuito
Content Hub -StarterÁmbitos Requeridos
Ámbitos Requeridos
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Query Parameters
Body
Response
successful operation
Show child attributes
Show child attributes
Una descripción de la propiedad que se mostrará como texto de ayuda en HubSpot.
Controla cómo aparece la propiedad en HubSpot.
El nombre del grupo de propiedades al que pertenece la propiedad.
Una etiqueta de propiedad legible para humanos que se mostrará en HubSpot.
El nombre interno de la propiedad, que debe usarse al referenciar la propiedad a través de la API.
Una lista de opciones válidas para la propiedad. Este campo es obligatorio para las propiedades enumeradas, pero estará vacío para otros tipos de propiedad.
Show child attributes
Show child attributes
Si es verdadero, la opción no se mostrará en formularios, bots o páginas de programación de reuniones. Compatible con las propiedades de enumeración de contactos, empresas, tickets y objetos personalizados.
Una etiqueta de opción legible para humanos que se mostrará en HubSpot.
El valor interno de la opción, que debe usarse al establecer el valor de la propiedad a través de la API.
Una descripción de la opción.
Las opciones se muestran en orden comenzando con el valor entero positivo más bajo. Los valores de -1 harán que la opción se muestre después de todos los valores positivos.
El tipo de datos de la propiedad.
Si la propiedad se archiva o no.
Cuando se archivó la propiedad.
Para las propiedades predeterminadas, true indica que la propiedad es calculada por un proceso de HubSpot. No tiene ningún efecto para las propiedades personalizadas.
Representa una fórmula que se utiliza para calcular una propiedad calculada.
La marca de tiempo en la que se creó la propiedad, en formato ISO 8601.
El ID interno del usuario que creó la propiedad en HubSpot. Este campo puede no existir si la propiedad se creó fuera de HubSpot.
Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".
highly_sensitive, non_sensitive, sensitive absolute, absolute_with_relative, time_since, time_until Las propiedades se muestran en orden, comenzando con el valor entero positivo más bajo.
Para las propiedades predeterminadas, true (verdadero) indica que las opciones se almacenan fuera de la configuración de la propiedad.
Si la propiedad se puede usar en un formulario de HubSpot o no.
Si el valor de la propiedad debe ser único o no. Una vez establecido, esto no se puede cambiar.
Si es verdadero, la opción no se mostrará en formularios, bots o páginas de programación de reuniones. Compatible con las propiedades de enumeración de contactos, empresas, tickets y objetos personalizados.
Esto será verdadero para las propiedades de objeto predeterminadas integradas en HubSpot.
Si esta propiedad está relacionada con otros objetos, esos objetos se mostrarán aquí.
When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").
Si la propiedad mostrará o no el símbolo de divisa en la configuración de la cuenta.
La marca de tiempo en la que se actualizó la propiedad, en formato ISO 8601.
El ID interno del usuario que creó la propiedad en HubSpot. Este campo puede no existir si la propiedad se actualizó fuera de HubSpot.
CANCELED, COMPLETE, PENDING, PROCESSING Show child attributes
Show child attributes
La categoría principal del error.
Los objetos de error detallados.
Show child attributes
Show child attributes
Un mensaje legible en el que se describa el error y los pasos para solucionarlo, si procede.
El código de estado asociado con el detalle del error
El nombre del campo o parámetro en el que se encontró el error.
Una categoría específica que contiene detalles más concretos sobre el error
Un mensaje legible en el que se describa el error y los pasos para solucionarlo.
El código de estado HTTP asociado al error.
El ID único de la instancia del error.
Una categoría de error más específica dentro de cada categoría principal.