GET
/
crm
/
v3
/
properties
/
{objectType}
/
{propertyName}
Ler uma propriedade
curl --request GET \
  --url https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubStarter

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • crm.objects.orders.read
  • crm.objects.appointments.sensitive.read.v2
  • crm.schemas.listings.read
  • crm.objects.contacts.highly_sensitive.read.v2
  • crm.schemas.carts.read
  • automation
  • crm.objects.companies.write
  • crm.objects.custom.sensitive.read.v2
  • crm.objects.users.read
  • crm.objects.commercepayments.write
  • crm.objects.invoices.write
  • crm.objects.contacts.highly_sensitive.write.v2
  • crm.objects.appointments.write
  • crm.objects.custom.write
  • tickets
  • crm.objects.deals.sensitive.write.v2
  • crm.schemas.appointments.read
  • crm.objects.deals.highly_sensitive.write.v2
  • crm.objects.companies.highly_sensitive.write.v2
  • tickets.sensitive.v2
  • crm.objects.appointments.read
  • crm.schemas.courses.read
  • crm.objects.appointments.sensitive.write.v2
  • crm.schemas.custom.read
  • crm.objects.marketing_events.write
  • media_bridge.read
  • crm.schemas.commercepayments.read
  • crm.objects.listings.read
  • crm.objects.courses.write
  • crm.objects.carts.read
  • crm.objects.listings.write
  • crm.objects.custom.read
  • crm.objects.deals.read
  • crm.objects.subscriptions.read
  • crm.objects.owners.read
  • crm.objects.companies.sensitive.read.v2
  • crm.schemas.quotes.read
  • crm.objects.companies.read
  • crm.objects.custom.sensitive.write.v2
  • crm.schemas.services.read
  • crm.objects.deals.highly_sensitive.read.v2
  • crm.objects.contacts.sensitive.write.v2
  • crm.objects.companies.highly_sensitive.read.v2
  • crm.schemas.subscriptions.read
  • crm.schemas.companies.read
  • crm.schemas.line_items.read
  • crm.objects.contacts.read
  • crm.objects.services.write
  • crm.objects.subscriptions.write
  • crm.objects.products.write
  • crm.objects.feedback_submissions.read
  • crm.objects.custom.highly_sensitive.read.v2
  • crm.objects.deals.write
  • crm.objects.invoices.read
  • e-commerce
  • crm.schemas.deals.read
  • crm.schemas.orders.read
  • crm.schemas.contacts.read
  • tickets.highly_sensitive.v2
  • crm.objects.quotes.write
  • crm.objects.leads.read
  • crm.objects.leads.write
  • crm.objects.custom.highly_sensitive.write.v2
  • crm.objects.deals.sensitive.read.v2
  • crm.objects.goals.write
  • crm.objects.companies.sensitive.write.v2
  • crm.objects.contacts.write
  • crm.objects.goals.read
  • crm.objects.line_items.read
  • crm.objects.contacts.sensitive.read.v2
  • crm.objects.line_items.write
  • crm.objects.courses.read
  • timeline
  • crm.pipelines.orders.read
  • crm.schemas.invoices.read
  • crm.objects.quotes.read
  • crm.objects.services.read
  • crm.objects.marketing_events.read

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
objectType
string
required
​
propertyName
string
required

Query Parameters

​
archived
boolean
default:false

Se apenas os resultados que foram arquivados devem ser retornados.

​
properties
string

Response

200
application/json

successful operation

A HubSpot property