Skip to main content

Sprout Social

Social media management connector for profiles, publishing, analytics, inbox messages, Care cases, and Listening in Sprout Social.

Set up​

Sprout Social connects with credentials from your Sprout Social account. Have these values ready:

  • API access token
  1. Go to Organization > Connectors and find Sprout Social.
  2. Click Enable and choose which tools to allow.
  3. Each member enters their own values the first time they use it.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

Tools​

Sprout Social offers 18 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (16)​

View and search information without changing it.

ToolWhat it does
get_postGet a publishing (draft) post by its publishing_post_id (returned from create_post).
get_profile_analyticsGet daily profile performance analytics for one or more profiles over a date range.
get_topic_metricsGet aggregated metrics for a Listening topic over a date range (volume, authors, sentiment, engagements, etc.), optionally bucketed by dimensions (e.g. created_time.by(day), network, sentiment).
list_casesList Care cases.
list_clientsList the Sprout Social accounts (customers) your credentials can access, with their customer_id and name.
list_groupsList the groups in the account (group_id and name).
list_messagesList inbox messages (comments, mentions, DMs, etc.) for a profile.
list_postsList sent posts with lifetime performance metrics for one or more profiles over a created-time window.
list_profilesList the social profiles connected to the account (Twitter/X, Facebook, Instagram, LinkedIn, etc.) with their customer_profile_id, network, and handle.
list_queuesList the Care case queues in the account (id, name, description, associated teams).
list_tagsList the message tags (labels and campaigns) in the account, including archived ones (tag_id, text, type, active).
list_teamsList the teams in the account (id, name, description).
list_topic_messagesList individual messages (mentions) inside a Listening topic over a date range.
list_topicsList the Listening topics in the account (id, name, type, description).
list_usersList the users in the account (id, name, email).
validate_credentialValidate Sprout Social credentials by fetching the accessible account.

Write (2)​

Create or send data.

ToolWhat it does
create_postCreate a DRAFT post on one or more profiles.
upload_mediaUpload an image or video to Sprout from a public URL and get a media_id to attach to a post. content_type (e.g. image/jpeg) is inferred from the URL extension if omitted.
⌘J