GET
/
crm
/
v3
/
objects
/
{objectType}
Lista
curl --request GET \
  --url https://api.hubapi.com/crm/v3/objects/{objectType} \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "associations": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "archived": true,
      "archivedAt": "2023-11-07T05:31:56Z",
      "propertiesWithHistory": {},
      "id": "<string>",
      "objectWriteTraceId": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "paging": {
    "next": {
      "after": "NTI1Cg%3D%3D",
      "link": "?after=NTI1Cg%3D%3D"
    },
    "prev": {
      "before": "<string>",
      "link": "<string>"
    }
  }
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubGrátis

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • crm.objects.orders.read
  • crm.objects.appointments.sensitive.read.v2
  • crm.objects.contacts.highly_sensitive.read.v2
  • crm.objects.companies.write
  • crm.objects.custom.sensitive.read.v2
  • crm.objects.users.read
  • crm.objects.users.write
  • crm.objects.commercepayments.write
  • crm.objects.invoices.write
  • crm.objects.contacts.highly_sensitive.write.v2
  • crm.objects.carts.write
  • crm.objects.appointments.write
  • crm.objects.partner-services.read
  • crm.objects.custom.write
  • tickets
  • crm.objects.deals.sensitive.write.v2
  • oauth
  • crm.objects.deals.highly_sensitive.write.v2
  • crm.objects.companies.highly_sensitive.write.v2
  • tickets.sensitive.v2
  • crm.objects.appointments.read
  • crm.objects.appointments.sensitive.write.v2
  • media_bridge.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.companies.sensitive.read.v2
  • crm.objects.companies.read
  • crm.objects.custom.sensitive.write.v2
  • crm.objects.deals.highly_sensitive.read.v2
  • crm.objects.contacts.sensitive.write.v2
  • crm.objects.companies.highly_sensitive.read.v2
  • crm.objects.partner-services.write
  • crm.objects.contacts.read
  • crm.objects.services.write
  • crm.objects.orders.write
  • crm.objects.subscriptions.write
  • crm.objects.commercepayments.read
  • crm.objects.products.write
  • crm.objects.custom.highly_sensitive.read.v2
  • crm.objects.deals.write
  • crm.objects.invoices.read
  • e-commerce
  • 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.partner-clients.write
  • crm.objects.line_items.read
  • crm.objects.contacts.sensitive.read.v2
  • crm.objects.line_items.write
  • crm.objects.products.read
  • crm.objects.courses.read
  • crm.objects.quotes.read
  • crm.objects.partner-clients.read
  • crm.objects.services.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

Query Parameters

​
limit
integer
default:10

O número máximo de resultados a serem exibidos por página.

​
after
string

O token do cursor de paginação do último recurso lido com sucesso será retornado como a propriedade JSON "paging.next.after" de uma resposta paginada que contém mais resultados.

​
properties
string[]

Uma lista separada por vírgulas das propriedades a serem retornadas na resposta. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, ela será ignorada.

​
propertiesWithHistory
string[]

Uma lista separada por vírgulas das propriedades a serem retornadas junto com seu histórico de valores anteriores. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, elas serão ignoradas. O uso deste parâmetro reduzirá o número máximo de objetos que podem ser lidos por uma solicitação.

​
associations
string[]

Uma lista separada por vírgulas de tipos de objeto para recuperar IDs associados. Se alguma das associações especificadas não existir, elas serão ignoradas.

​
archived
boolean
default:false

Se apenas os resultados que foram arquivados devem ser retornados.

Response

200
application/json

successful operation

The response is of type object.