Social

GET social media profiles

Changed on

Retrieves all social media profiles connected to the account. A profile represents a single account on a social network (such as a Facebook Business Page, a LinkedIn Company Page, or an Instagram Business account) that the user has connected to Constant Contact.

Use the include=accessible query parameter to additionally check whether each profile is currently accessible for posting. Profiles that are not currently accessible will fail if used to publish a post.

get/social/profiles

Request

  • Base URL
    https://api.cc.email/v3
  • URL
    https://api.cc.email/v3/social/profiles
  • Auth
    • OAuth 2
      Implicit: https://authz.constantcontact.com/oauth2/default/v1/authorize
      Scopes: campaign_data
    • or OAuth 2
      Authorization code: https://authz.constantcontact.com/oauth2/default/v1/authorize
      Token URL: https://authz.constantcontact.com/oauth2/default/v1/token scopes: campaign_data

Query parameters

includestring[]

Optional sub-resources to include. Use accessible to check if profiles are accessible on the network.

Response

Request successful

accessibleboolean

Whether the profile is currently accessible for posting. Publishing a post will fail if its profile is not currently accessible. Only populated when the GET request includes the query parameter <code>include=accessible</code>.

connectedboolean required

Whether this profile is currently connected. You can only create and publish posts with connected profiles.

handlestring

The profile's handle on the social network (for example, an Instagram or TikTok username). May be <code>null</code> if the network does not expose a separate handle (for example, Facebook).

image_urlstring

URL of the profile's image or avatar.

namestring

Display name of the profile.

networkstring required

The social network this profile belongs to.

network_profile_idstring

The social network-specific identifier for this profile.

network_user_idstring

The social network-specific identifier for the user who owns this profile.

profile_idstring required

Unique identifier for this profile. Use this value in the <code>profile_id</code> field of a <code>ProfilePost</code> when creating a post.

settingsobject

Network-specific settings for the profile. Only populated when the request includes <code>include=accessible</code> and settings are available for the network. Currently, only TikTok provides settings: <pre>"content": { "comment_disabled": Boolean, "duet_disabled": Boolean, "stitch_disabled": Boolean, "max_video_post_duration_sec": Integer }</pre>

urlstring

URL to the profile on the social network.

Example response

[
  {
    "account_info": {
      "display_name": "John Doe",
      "image_url": "https://example.com/avatar.jpg",
      "network": "facebook",
      "username": "johndoe"
    },
    "connected": true,
    "handle": "mybusinesspage",
    "image_url": "https://example.com/profile-image.jpg",
    "name": "My Business Page",
    "network": "facebook",
    "url": "https://www.facebook.com/mybusinesspage"
  }
]

Changes