GET
/
events
/
v3
/
events
/
Consulta de instância do evento
curl --request GET \
  --url https://api.hubapi.com/events/v3/events/ \
  --header 'Authorization: Bearer <token>'
{
  "paging": {
    "next": {
      "link": "",
      "after": ""
    },
    "prev": {
      "before": "",
      "link": ""
    }
  },
  "results": [
    {
      "occurredAt": "2023-11-07T05:31:56Z",
      "eventType": "<string>",
      "id": "<string>",
      "objectId": "<string>",
      "properties": {},
      "objectType": "<string>"
    }
  ]
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubEnterprise
Sales HubSales HubEnterprise
Service HubService HubEnterprise
Content HubContent HubEnterprise

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • oauth

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
objectType
string

O nome do tipo de objeto do CRM no qual filtrar instâncias de eventos. Opcionalmente, você também pode fornecer um objectId em outro parâmetro para filtrar para uma instância específica do objeto do CRM.

​
eventType
string

O nome do tipo de evento. Uma lista de nomes de tipos de evento disponíveis pode ser obtida em outra chamada de API.

​
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.

​
before
string
​
limit
integer

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

​
sort
string[]

Classifique a direção com base na data e hora da instância do evento, ASCENDING (crescente) ou DESCENDING (decrescente).

​
occurredAfter
string<date-time>

Filter for event data that occurred after a specific datetime.

​
occurredBefore
string<date-time>

Filter for event data that occurred before a specific datetime.

​
objectId
integer

O ID do objeto do CRM no qual filtrar instâncias de eventos. Se estiver filtrando por objectId, você também deverá fornecer um objectType.

​
objectProperty.{propname}
object

Instead of retrieving event data for a specific object by its ID, you can specify a unique identifier property. For contacts, you can use the email property. (e.g., objectProperty.email=name@domain.com).

​
property.{propname}
object

Filter for event completions that contain a specific value for an event property (e.g., property.hs_city=portland). For properties values with spaces, replaces spaces with %20 or + (e.g., property.hs_city=new+york).

​
id
string[]

ID de uma instância de evento. Os IDs são individuais para as instâncias de eventos. Se você fornecer esse filtro e filtros adicionais, os outros filtros deverão corresponder aos valores na instância do evento para produzir resultados.

Response

200
application/json

successful operation

The response is of type object.