Skip to main content
GET
/
broadcast
/
v1
/
broadcasts
Get broadcast messages
curl --request GET \
  --url https://api.hubapi.com/broadcast/v1/broadcasts \
  --header 'Authorization: Bearer <token>'
{
  "broadcast_list": {
    "summary": "broadcasts_response",
    "value": [
      {
        "broadcastGuid": "4745142",
        "portalId": 62515,
        "groupGuid": "9e714a24-4973-452b-8622-cfd2e072b0cf",
        "campaignGuid": null,
        "channelKey": "Twitter:403551555",
        "channelGuid": "cd0bccfc-390d-3840-aa77-d413b253c807",
        "clientTag": "SocialUI_clone",
        "createdAt": 1553275615529,
        "userUpdatedAt": 1554967001342,
        "triggerAt": 1563386460000,
        "finishedAt": null,
        "status": "DRAFT",
        "message": null,
        "content": {
          "originalLink": null,
          "charCount": "22",
          "originalBody": "test test a video post",
          "uncompressedLinks": null,
          "hashtagCount": "0",
          "body": "test test a video post",
          "title": "test test a video post",
          "thumbUrl": "https://cdn2.hubspot.com/hubfs/62515/social-suggested-images/2019-video.mp4/thumb.jpg",
          "fileId": "3385520023"
        },
        "foreignId": null,
        "remoteContentId": null,
        "remoteContentType": null,
        "clicks": 0,
        "createdBy": 546233,
        "updatedBy": 546233,
        "campaignName": null,
        "broadcastMediaType": "VIDEO",
        "wasDraft": true,
        "channel": null,
        "serviceId": null,
        "extraData": {
          "files": [
            {
              "url": "https://cdn2.hubspot.com/hubfs/62515/social-suggested-images/2019-video.mp4",
              "mediaType": "VIDEO",
              "height": 300,
              "width": 600,
              "description": null,
              "id": 3385520023
            }
          ],
          "body": "test test a video post",
          "updatedClientTag": "SocialUI_composer"
        },
        "isPending": false,
        "isPublished": false,
        "isFailed": false,
        "isRetry": false,
        "messageText": "test test a video post"
      },
      {
        "broadcastGuid": "4755879",
        "portalId": 62515,
        "groupGuid": "d108c94c-45f3-4f4f-b449-c0b8d87638c7",
        "campaignGuid": null,
        "channelKey": "LinkedInCompanyPage:9285502",
        "channelGuid": "fbc18527-e718-3979-b57b-11c75dc6f18e",
        "clientTag": "SocialUI_composer",
        "createdAt": 1559244927778,
        "userUpdatedAt": 1559244927778,
        "triggerAt": 1559244927778,
        "finishedAt": 1559244991570,
        "status": "SUCCESS",
        "message": "This broadcast is currently executing\n----Appended Message----\nThis broadcast finished without errors",
        "content": {
          "charCount": "52",
          "originalBody": "Publishing a video post which should not be ignored ",
          "uncompressedLinks": null,
          "hashtagCount": "0",
          "body": "Publishing a video post which should not be ignored ",
          "thumbUrl": "https://cdn2.hubspot.com/hubfs/62515/IMG_6679.mov/thumb.jpg",
          "title": "Publishing a video post which should not be ignored ",
          "fileId": "3304976613"
        },
        "foreignId": "urn:li:ugcPost:123456",
        "remoteContentId": null,
        "remoteContentType": null,
        "clicks": 0,
        "createdBy": 546233,
        "updatedBy": null,
        "campaignName": null,
        "broadcastMediaType": "VIDEO",
        "wasDraft": false,
        "channel": null,
        "serviceId": null,
        "extraData": {
          "files": [
            {
              "url": "https://cdn2.hubspot.com/hubfs/62515/IMG_6679.mov",
              "mediaType": "VIDEO",
              "height": 1080,
              "width": 1920,
              "description": null,
              "id": 3304976613
            }
          ],
          "body": "Publishing a video post which should not be ignored ",
          "updatedClientTag": null
        },
        "isPending": false,
        "isPublished": true,
        "isFailed": false,
        "isRetry": false,
        "messageText": "Publishing a video post which should not be ignored "
      }
    ]
  }
}
Please note: the social media API is deprecated. While previous functionality is supported in a limited capacity, you should not use this API if you’re building a new app.

​
Required Scopes

This API requires one of the following scopes:
  • social

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
status
string

Only include broadcasts in matching state (success, waiting, canceled, error_fatal).

​
since
string

Only include broadcasts created at or more recently than given timestamp (milliseconds from epoch).

​
withChannelKeys
string

Only include broadcasts created on specific channels. To request multiple channels, include the withChannelKeys parameter multiple times.

​
count
integer<int32>

Only include specified number of results.

​
offset
integer<int32>

Used to get the next set of results. Increment the offset by the number your using in the count parameter to get the next set of results.

Response

Successful operation

​
broadcastGuid
string

Unique identifier for the broadcast provided by the social network

​
portalId
integer<int32>

ID of the HubSpot account

​
groupGuid
string

Unique identifier for the parent entity of the broadcast (e.g., a Facebook page ID)

​
campaignGuid
string

ID of an associated HubSpot campaign

​
channelKey
string

A key that concatenates the network with the channelId

​
channelGuid
string

Unique identifier for the channel provided by the social network

​
clientTag
string

An internal identifier for HubSpot's integration

​
createdAt
integer<int32>

Timestamp for when the broadcast was created

​
userUpdatedAt
integer<int32>

A unix timestamp in milliseconds that corresponds to when the user last updated the broadcast

​
triggerAt
integer<int32>

A unix timestamp in milliseconds that corresponds to a scheduled time to publish the broadcast

​
finishedAt
integer<int32>

A unix timestamp in milliseconds when the post was successfully published

​
status
string

The status of the broadcast (e.g., 'DRAFT')

​
message
string

An optional field included in the broadcasts of certain social networks.

​
content
object

The content of your broadcast, the properties for which varies by network.

​
foreignId
integer<int32>

An internal identifier for the broadcast.

​
remoteContentId
integer<int32>

An internal identifier for the broadcast.

​
remoteContentType
string

An internal type of the broadcast.

​
clicks
integer<int32>

The number clicks the broadcast has received

​
createdBy
integer<int32>

The ID of the HubSpot user who created the broadcast

​
updatedBy
integer<int32>

The ID of the HubSpot user who last updated the broadcast

​
campaignName
string

The name of the associated HubSpot campaign, if applicable

​
broadcastMediaType
string

The format of the broadcast (e.g., 'VIDEO')

​
wasDraft
boolean

Whether the broadcast was previously in a drafted state before officially posting to the network.

​
channel
string

An internal identifier used by HubSpot.

​
serviceId
integer<int32>

An internal identifier used by HubSpot.

​
extraData
object

An object with additional data included with the broadcast, including any files, broadcast body text, and an internal client tag used by HubSpot.

​
isPending
boolean

An internal field used to identify whether the broadcast is still pending.

​
isPublished
boolean

An internal field used to identify whether the broadcast was successfully published.

​
isFailed
boolean

An internal field used to identify whether the broadcast failed to be posted to the network.

​
isRetry
boolean

An internal field used to identify whether the broadcast had to be retried.

​
messageText
string

Inner text body of the broadcast