GET
/
marketing
/
v3
/
marketing-events
/
events
/
{externalEventId}
Get Marketing Event by External IDs
curl --request GET \
  --url https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId} \
  --header 'Authorization: Bearer <token>'
{
  "registrants": 123,
  "eventOrganizer": "<string>",
  "eventUrl": "<string>",
  "attendees": 123,
  "eventType": "<string>",
  "eventCompleted": true,
  "endDateTime": "2023-11-07T05:31:56Z",
  "noShows": 123,
  "cancellations": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "startDateTime": "2023-11-07T05:31:56Z",
  "customProperties": [
    {
      "sourceId": "",
      "selectedByUser": false,
      "sourceLabel": "",
      "sourceUpstreamDeployable": "<string>",
      "source": "",
      "updatedByUserId": 123,
      "persistenceTimestamp": 123,
      "sourceMetadata": "",
      "dataSensitivity": "",
      "sourceVid": "",
      "unit": "",
      "requestId": "",
      "isEncrypted": false,
      "name": "",
      "useTimestampAsPersistenceTimestamp": true,
      "value": "",
      "selectedByUserTimestamp": 123,
      "timestamp": 123,
      "isLargeValue": true
    }
  ],
  "eventCancelled": true,
  "externalEventId": "<string>",
  "eventDescription": "<string>",
  "eventName": "<string>",
  "id": "<string>",
  "objectId": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubFree
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubStarter

​
Required Scopes

This API requires one of the following scopes:
  • 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

​
externalEventId
string
required

The id of the marketing event in the external event application

Query Parameters

​
externalAccountId
string
required

The accountId that is associated with this marketing event in the external event application

Response

200
application/json

successful operation

The response is of type object.