Skip to main content
GET
/
media-bridge
/
v1
/
{appId}
/
properties
/
{objectType}
/
{propertyName}
Obtener los datos de una propiedad
curl --request GET \
  --url https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}/{propertyName}
{
  "favoritedOrder": 123,
  "enforceMultivalueUniqueness": true,
  "readOnlyValue": true,
  "hidden": false,
  "optionSortStrategy": "DISPLAY_ORDER",
  "displayOrder": 123,
  "description": "<string>",
  "showCurrencySymbol": true,
  "type": "string",
  "readOnlyDefinition": true,
  "hubspotDefined": true,
  "allowedObjectTypes": [
    {
      "innerId": 123,
      "metaTypeId": 123
    }
  ],
  "createdAt": 123,
  "searchTextAnalysisMode": "NONE",
  "textDisplayHint": "unformatted_single_line",
  "portalId": 123,
  "options": [
    {
      "hidden": true,
      "displayOrder": 123,
      "doubleData": 123,
      "description": "<string>",
      "readOnly": true,
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "isPartial": true,
  "optionsAreMutable": true,
  "hasUniqueValue": true,
  "calculated": true,
  "externalOptions": true,
  "dateDisplayHint": "absolute",
  "favorited": true,
  "updatedAt": 123,
  "createdUserId": 123,
  "canArchive": true,
  "fromUserId": 123,
  "mutableDefinitionNotDeletable": true,
  "isMultiValued": true,
  "sensitiveDataCategories": [
    "<string>"
  ],
  "canRestore": true,
  "currencyPropertyName": "<string>",
  "owningAppId": 123,
  "isCustomizedDefault": true,
  "label": "<string>",
  "formField": true,
  "displayMode": "current_value",
  "dataSensitivity": "none",
  "groupName": "<string>",
  "deleted": true,
  "referencedObjectType": "CONTACT",
  "name": "<string>",
  "searchableInGlobalSearch": true,
  "externalOptionsReferenceType": "<string>",
  "numberDisplayHint": "unformatted",
  "fieldType": "<string>"
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubGratuito
Sales HubSales HubGratuito
Service HubService HubGratuito
Content HubContent HubGratuito

Authorizations

​
hapikey
string
query
required

Path Parameters

​
objectType
string
required

El tipo de objeto para la propiedad.

​
propertyName
string
required

El nombre de la propiedad de la que se obtendrán los detalles.

​
appId
integer
required

El appId de la aplicación del centro multimedia. Es posible tener varias aplicaciones en tu cuenta de desarrollador que utilicen el centro multimedia.

Query Parameters

​
archived
boolean
default:false

Si se quieren devolver solo los resultados que se han archivado.

​
properties
string

Limita la respuesta para que solo incluya las propiedades especificadas.

Response

successful operation

A HubSpot property

​
favoritedOrder
integer
required

Obsoleto. La posición del pedido cuando se marca como favorito.

​
enforceMultivalueUniqueness
boolean
required
​
readOnlyValue
boolean
required

Indica si el valor de la propiedad es de solo lectura.

​
hidden
boolean
required

Si la propiedad se ocultará o no de la IU de HubSpot. Se recomienda que esto se establezca en falso para las propiedades personalizadas.

Example:

false

​
optionSortStrategy
enum<string>
required

Especifica cómo ordenar las opciones de propiedades. Puede ser "DISPLAY_ORDER" para diferir al campo displayOrder, o "ALPHABETICAL".

Available options:
DISPLAY_ORDER,
ALPHABETICAL
​
displayOrder
integer
required

La posición del elemento en relación con otros de la lista.

​
description
string
required

Un resumen de la finalidad de la propiedad.

​
showCurrencySymbol
boolean
required

Si se muestra el símbolo de la divisa en la IU de HubSpot.

​
type
enum<string>
required

El tipo de datos de la propiedad, como cadena o número.

Available options:
string,
number,
bool,
datetime,
enumeration,
date,
phone_number,
currency_number,
json,
object_coordinates
​
readOnlyDefinition
boolean
required

Si la descripción de la propiedad es de solo lectura.

​
hubspotDefined
boolean
required

Un valor booleano establecido en verdadero para las propiedades predeterminadas de HubSpot.

​
allowedObjectTypes
object[]
required

Tipos de objeto que pueden utilizar esta propiedad.

​
createdAt
integer
required

La marca de tiempo en la que se creó la propiedad, en formato ISO 8601.

​
searchTextAnalysisMode
enum<string>
required
Available options:
NONE,
NOT_ANALYZED_TEXT
​
textDisplayHint
enum<string>
required

Sugerencia sobre cómo se muestra y valida el texto en la IU de HubSpot. Puede ser: "unformatted_single_line", "multi_line", "email", "phone_number", "domain_name", "ip_address", "physical_address" o "postal_code".

Available options:
unformatted_single_line,
multi_line,
email,
phone_number,
domain_name,
ip_address,
physical_address,
postal_code
​
portalId
integer
required

El ID de la cuenta de HubSpot donde se define la propiedad.

​
options
object[]
required

Una lista de opciones válidas para la propiedad. Este campo es obligatorio para las propiedades enumeradas.

​
isPartial
boolean
required

Para propiedades predeterminadas, si la propiedad ha sido personalizada. Equivale al campo "isCustomizedDefault".

​
optionsAreMutable
boolean
required

Si las opciones se pueden modificar después de la creación.

​
hasUniqueValue
boolean
required

Si la propiedad es un identificador único.

​
calculated
boolean
required

Si la propiedad es un campo calculado.

​
externalOptions
boolean
required

Aplicable solo a propiedades de tipo de enumeración. Debe establecerse en verdadero con un "referencedObjectType" de "OWNER". De lo contrario, falso.

​
dateDisplayHint
enum<string>
required
Available options:
absolute,
absolute_with_relative,
time_since,
time_until
​
favorited
boolean
required

Obsoleto. Si la propiedad está marcada como favorita.

​
updatedAt
integer
required

La marca de tiempo en la que se actualizó la propiedad, en formato ISO 8601.

​
createdUserId
integer
required

El ID del usuario que creó la propiedad.

​
canArchive
boolean
required
​
fromUserId
integer
required

El ID del usuario que actualizó la propiedad por última vez.

​
mutableDefinitionNotDeletable
boolean
required

Si la definición de la propiedad se puede personalizar pero no eliminar.

​
isMultiValued
boolean
required

Si la propiedad puede contener múltiples valores.

​
sensitiveDataCategories
string[]
required

Cuando sensitiveData es verdadero, enumera el tipo de datos sensibles contenidos en la propiedad (por ejemplo, "HIPAA").

​
canRestore
boolean
required
​
currencyPropertyName
string
required

El nombre de la propiedad de divisa relacionada.

​
owningAppId
integer
required
​
isCustomizedDefault
boolean
required

Para propiedades predeterminadas, si la propiedad ha sido personalizada. Equivale al campo "isCustomizedDefault".

​
label
string
required

La etiqueta de visualización de la propiedad.

​
formField
boolean
required

Si la propiedad puede aparecer en los formularios.

​
displayMode
enum<string>
required

El modo en el que se muestra la propiedad. Puede ser: "current_value" or "all_unique_versions".

Available options:
current_value,
all_unique_versions
​
dataSensitivity
enum<string>
required

Indica el nivel de sensibilidad de la propiedad, como "non_sensitive", "sensitive", or "highly_sensitive".

Available options:
none,
standard,
high
​
groupName
string
required

El nombre del grupo al que se asigna la propiedad.

​
deleted
boolean
required

Si la propiedad fue eliminada.

​
referencedObjectType
enum<string>
required

Obsoleto. Utiliza externalOptionsReferenceType en su lugar.

Available options:
CONTACT,
COMPANY,
DEAL,
ENGAGEMENT,
TICKET,
OWNER,
PRODUCT,
LINE_ITEM,
BET_DELIVERABLE_SERVICE,
CONTENT,
CONVERSATION,
BET_ALERT,
PORTAL,
QUOTE,
FORM_SUBMISSION_INBOUNDDB,
QUOTA,
UNSUBSCRIBE,
COMMUNICATION,
FEEDBACK_SUBMISSION,
ATTRIBUTION,
SALESFORCE_SYNC_ERROR,
RESTORABLE_CRM_OBJECT,
HUB,
LANDING_PAGE,
PRODUCT_OR_FOLDER,
TASK,
FORM,
MARKETING_EMAIL,
AD_ACCOUNT,
AD_CAMPAIGN,
AD_GROUP,
AD,
KEYWORD,
CAMPAIGN,
SOCIAL_CHANNEL,
SOCIAL_POST,
SITE_PAGE,
BLOG_POST,
IMPORT,
EXPORT,
CTA,
TASK_TEMPLATE,
AUTOMATION_PLATFORM_FLOW,
OBJECT_LIST,
NOTE,
MEETING_EVENT,
CALL,
EMAIL,
PUBLISHING_TASK,
CONVERSATION_SESSION,
CONTACT_CREATE_ATTRIBUTION,
INVOICE,
MARKETING_EVENT,
CONVERSATION_INBOX,
CHATFLOW,
MEDIA_BRIDGE,
SEQUENCE,
SEQUENCE_STEP,
FORECAST,
SNIPPET,
TEMPLATE,
DEAL_CREATE_ATTRIBUTION,
QUOTE_TEMPLATE,
QUOTE_MODULE,
QUOTE_MODULE_FIELD,
QUOTE_FIELD,
SEQUENCE_ENROLLMENT,
SUBSCRIPTION,
ACCEPTANCE_TEST,
SOCIAL_BROADCAST,
DEAL_SPLIT,
DEAL_REGISTRATION,
GOAL_TARGET,
GOAL_TARGET_GROUP,
PORTAL_OBJECT_SYNC_MESSAGE,
FILE_MANAGER_FILE,
FILE_MANAGER_FOLDER,
SEQUENCE_STEP_ENROLLMENT,
APPROVAL,
APPROVAL_STEP,
CTA_VARIANT,
SALES_DOCUMENT,
DISCOUNT,
FEE,
TAX,
MARKETING_CALENDAR,
PERMISSIONS_TESTING,
PRIVACY_SCANNER_COOKIE,
DATA_SYNC_STATE,
WEB_INTERACTIVE,
PLAYBOOK,
FOLDER,
PLAYBOOK_QUESTION,
PLAYBOOK_SUBMISSION,
PLAYBOOK_SUBMISSION_ANSWER,
COMMERCE_PAYMENT,
GSC_PROPERTY,
SOX_PROTECTED_DUMMY_TYPE,
BLOG_LISTING_PAGE,
QUARANTINED_SUBMISSION,
PAYMENT_SCHEDULE,
PAYMENT_SCHEDULE_INSTALLMENT,
MARKETING_CAMPAIGN_UTM,
DISCOUNT_TEMPLATE,
DISCOUNT_CODE,
FEEDBACK_SURVEY,
CMS_URL,
SALES_TASK,
SALES_WORKLOAD,
USER,
POSTAL_MAIL,
SCHEMAS_BACKEND_TEST,
PAYMENT_LINK,
SUBMISSION_TAG,
CAMPAIGN_STEP,
SCHEDULING_PAGE,
SOX_PROTECTED_TEST_TYPE,
ORDER,
MARKETING_SMS,
PARTNER_ACCOUNT,
CAMPAIGN_TEMPLATE,
CAMPAIGN_TEMPLATE_STEP,
PLAYLIST,
CLIP,
CAMPAIGN_BUDGET_ITEM,
CAMPAIGN_SPEND_ITEM,
MIC,
CONTENT_AUDIT,
CONTENT_AUDIT_PAGE,
PLAYLIST_FOLDER,
LEAD,
ABANDONED_CART,
EXTERNAL_WEB_URL,
VIEW,
VIEW_BLOCK,
ROSTER,
CART,
AUTOMATION_PLATFORM_FLOW_ACTION,
SOCIAL_PROFILE,
PARTNER_CLIENT,
ROSTER_MEMBER,
MARKETING_EVENT_ATTENDANCE,
ALL_PAGES,
AI_FORECAST,
CRM_PIPELINES_DUMMY_TYPE,
KNOWLEDGE_ARTICLE,
PROPERTY_INFO,
DATA_PRIVACY_CONSENT,
GOAL_TEMPLATE,
SCORE_CONFIGURATION,
AUDIENCE,
PARTNER_CLIENT_REVENUE,
AUTOMATION_JOURNEY,
COMBO_EVENT_CONFIGURATION,
CRM_OBJECTS_DUMMY_TYPE,
CASE_STUDY,
SERVICE,
PODCAST_EPISODE,
PARTNER_SERVICE,
PROSPECTING_AGENT_CONTACT_ASSIGNMENT,
UNKNOWN
​
name
string
required

El nombre interno de la propiedad.

​
searchableInGlobalSearch
boolean
required

Si la propiedad se puede buscar globalmente.

​
externalOptionsReferenceType
string
required

Cuando externalOptions es verdadero, indica que los valores de opción de la propiedad se rellenarán desde otros sistemas (por ejemplo, "OWNER" para la propiedad hubspot_owner_id).

​
numberDisplayHint
enum<string>
required

Sugerencia sobre cómo se muestra y valida una propiedad numérica en la IU de HubSpot. Puede ser: "unformatted", "formatted", "currency", "percentage", "duration" o "probability".

Available options:
unformatted,
formatted,
currency,
percentage,
duration,
probability
​
fieldType
string
required

Determina cómo aparecerá la propiedad en la IU de HubSpot o en un formulario. Más información en la guía de la API de propiedades.