Zum Hauptinhalt springen
GET
/
crm
/
v3
/
properties
/
{objectType}
/
groups
/
{groupName}
Ler um grupo de propriedades
curl --request GET \
  --url https://api.hubapi.com/crm/v3/properties/{objectType}/groups/{groupName} \
  --header 'Authorization: Bearer <token>'
{
  "displayOrder": -1,
  "label": "My Property Group",
  "name": "mypropertygroup"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Starter
Esta API requer um dos seguintes escopos:
automation
crm.objects.appointments.read
crm.objects.appointments.sensitive.read.v2
crm.objects.appointments.sensitive.write.v2
crm.objects.appointments.write
crm.objects.carts.read
crm.objects.commercepayments.write
crm.objects.companies.highly_sensitive.read.v2
crm.objects.companies.highly_sensitive.write.v2
crm.objects.companies.read
crm.objects.companies.sensitive.read.v2
crm.objects.companies.sensitive.write.v2
crm.objects.companies.write
crm.objects.contacts.highly_sensitive.read.v2
crm.objects.contacts.highly_sensitive.write.v2
crm.objects.contacts.read
crm.objects.contacts.sensitive.read.v2
crm.objects.contacts.sensitive.write.v2
crm.objects.contacts.write
crm.objects.courses.read
crm.objects.courses.write
crm.objects.custom.highly_sensitive.read.v2
crm.objects.custom.highly_sensitive.write.v2
crm.objects.custom.read
crm.objects.custom.sensitive.read.v2
crm.objects.custom.sensitive.write.v2
crm.objects.custom.write
crm.objects.deals.highly_sensitive.read.v2
crm.objects.deals.highly_sensitive.write.v2
crm.objects.deals.read
crm.objects.deals.sensitive.read.v2
crm.objects.deals.sensitive.write.v2
crm.objects.deals.write
crm.objects.feedback_submissions.read
crm.objects.goals.read
crm.objects.goals.write
crm.objects.invoices.read
crm.objects.invoices.write
crm.objects.leads.read
crm.objects.leads.write
crm.objects.line_items.read
crm.objects.line_items.write
crm.objects.listings.read
crm.objects.listings.write
crm.objects.marketing_events.read
crm.objects.marketing_events.write
crm.objects.orders.read
crm.objects.owners.read
crm.objects.products.write
crm.objects.quotes.read
crm.objects.quotes.write
crm.objects.services.read
crm.objects.services.write
crm.objects.subscriptions.read
crm.objects.subscriptions.write
crm.objects.users.read
crm.pipelines.orders.read
crm.schemas.appointments.read
crm.schemas.carts.read
crm.schemas.commercepayments.read
crm.schemas.companies.read
crm.schemas.contacts.read
crm.schemas.courses.read
crm.schemas.custom.read
crm.schemas.deals.read
crm.schemas.invoices.read
crm.schemas.line_items.read
crm.schemas.listings.read
crm.schemas.orders.read
crm.schemas.quotes.read
crm.schemas.services.read
crm.schemas.subscriptions.read
e-commerce
media_bridge.read
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2
timeline

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required
​
groupName
string
required

Response

successful operation

An ID for a group of properties

​
archived
boolean
required
​
name
string
required

O nome interno do grupo de propriedades, que deve ser usado ao referenciar o grupo pela API.

Example:

"mypropertygroup"

​
displayOrder
integer
required

Os grupos de propriedades são exibidos em ordem começando com o menor valor inteiro positivo. Valores de -1 farão com que o grupo de propriedades seja exibido após os valores positivos.

Example:

-1

​
label
string
required

Um rótulo legível por humanos que será exibido no HubSpot.

Example:

"My Property Group"

⌘I