---
canonical_url: "https://docs.composio.dev/toolkits/sprout_social"
markdown_url: "https://docs.composio.dev/toolkits/sprout_social.md"
product: "platform"
version: null
last_updated: null
---

# Sprout Social

Sprout Social provides social media analytics, listening, publishing, inbox, media, and customer-care APIs.

- **Category:** social media marketing
- **Auth:** S2S_OAUTH2, API_KEY
- **Composio-managed OAuth available?** No
- **Tools:** 20
- **Triggers:** 0
- **Slug:** `SPROUT_SOCIAL`
- **Version:** 00000000_00

## Tools

### Complete Multipart Media Upload

**Slug:** `SPROUT_SOCIAL_COMPLETE_MULTIPART_MEDIA_UPLOAD`

Finalize a Sprout media submission and wait through bounded HTTP 202 processing responses until the completed media ID is ready.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |
| `submission_id` | string | Yes | Media submission ID returned by Start Multipart Media Upload. |
| `poll_timeout_seconds` | number | No | Maximum total seconds to wait for the media submission to become ready. |
| `poll_interval_seconds` | number | No | Seconds between readiness checks. A future wait_until value from Sprout can delay the first check further. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Publishing Post Draft

**Slug:** `SPROUT_SOCIAL_CREATE_PUBLISHING_POST`

Create draft posts on the Sprout Publishing Calendar for one or more profiles and optional future delivery times. This never publishes immediately and returns every profile/time fan-out item created by Sprout.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | No | Post text. Whether text is required depends on the target network. |
| `media` | array | No | Ordered media attachments previously uploaded to Sprout. Unsupported profile/media combinations may be silently omitted from the fan-out. |
| `tag_ids` | array | No | Sprout tag IDs to apply to the draft. |
| `delivery` | object | No | Optional scheduling configuration for the draft deliveries. |
| `group_id` | integer | Yes | Sprout group containing every selected customer profile. |
| `is_draft` | boolean | Yes | Must be true because the public API supports only draft creation. |
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |
| `customer_profile_ids` | array | Yes | One or more customer profile IDs that all belong to group_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Filter Cases

**Slug:** `SPROUT_SOCIAL_FILTER_CASES`

Retrieve one page of Sprout social-care cases by case ID or date-bounded filters, with a continuation cursor when more cases are available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | Case sort order. Sprout supports one created_time or updated_time expression in ascending or descending order. |
| `limit` | integer | No | Maximum cases to return on this page (1-100). |
| `filters` | array | Yes | Sprout case filter expressions. Use case_id.eq(...) alone for up to 100 case IDs, or include at least one created_time, latest_activity_time, or updated_time range of at most one week. Optional filters are queue_id, message_id, tag_id, assigned_by, created_by, assigned_to, type (GENERAL, SUPPORT, LEAD, QUESTION, FEEDBACK), priority (HIGH, LOW, CRITICAL, MEDIUM, UNDEFINED), and status (OPEN, ON_HOLD, CLOSED). |
| `timezone` | string | No | ICANN time zone used to interpret case date and datetime filters. |
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |
| `page_cursor` | string | No | Continuation cursor returned as next_cursor by a prior call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Publishing Post

**Slug:** `SPROUT_SOCIAL_GET_PUBLISHING_POST`

Retrieve one Sprout Publishing Calendar post by ID, including its profile and scheduled-time fan-out. The returned delivery_status is not evidence that a post was delivered or published; use Query Messages to find a sent post.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |
| `publishing_post_id` | integer | Yes | Publishing Post ID returned by Create Publishing Post Draft. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Clients

**Slug:** `SPROUT_SOCIAL_LIST_CLIENTS`

List the Sprout customers the connected credential can access, including each customer ID needed by customer-scoped actions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Case Queues

**Slug:** `SPROUT_SOCIAL_LIST_CUSTOMER_CASE_QUEUES`

List active social-care case queues for a Sprout customer and the teams associated with each queue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Groups

**Slug:** `SPROUT_SOCIAL_LIST_CUSTOMER_GROUPS`

List the Sprout groups available to a customer, including group IDs required by message and publishing workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Profiles

**Slug:** `SPROUT_SOCIAL_LIST_CUSTOMER_PROFILES`

List owned social profiles accessible for a Sprout customer, including network, native identifiers, and group memberships.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Tags

**Slug:** `SPROUT_SOCIAL_LIST_CUSTOMER_TAGS`

List active and archived message tags for a Sprout customer. Deleted tags are not returned.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Teams

**Slug:** `SPROUT_SOCIAL_LIST_CUSTOMER_TEAMS`

List active teams configured for a Sprout customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Listening Topics

**Slug:** `SPROUT_SOCIAL_LIST_CUSTOMER_TOPICS`

List Listening Topics available to a Sprout customer, including topic IDs, themes, groups, and data availability times.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Users

**Slug:** `SPROUT_SOCIAL_LIST_CUSTOMER_USERS`

List active Sprout users for a customer with their IDs, names, and email addresses. The response contains sensitive customer user data and should only be used for authorized customer workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Listening Topic Messages

**Slug:** `SPROUT_SOCIAL_QUERY_LISTENING_TOPIC_MESSAGES`

Query raw messages, selected fields, and optional per-message metrics from one Sprout Listening Topic. Returns one provider page; Listening excludes X and does not provide message-level Reddit data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | One-indexed result page; omit to request the first page. |
| `sort` | array | No | Sort by message creation time in ascending or descending order. |
| `limit` | integer | No | Maximum Listening messages to return on this page (1-100). |
| `fields` | array | Yes | One or more documented Listening Message Fields to return. |
| `filters` | array | Yes | Listening filter expressions using Sprout's gt, gte, lt, lte, in, eq, neq, exists, or match operators. Common filters select created_time and network. |
| `metrics` | array | No | Optional documented per-message Listening metric keys to return. |
| `timezone` | string | No | ICANN time zone used to interpret date/time filters; responses remain UTC. |
| `topic_id` | string | Yes | Listening Topic ID returned by List Customer Listening Topics. |
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |
| `scale_metrics_with_reposts` | boolean | No | Whether Bluesky reposts count toward volume metrics. This setting affects Bluesky only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Listening Topic Metrics

**Slug:** `SPROUT_SOCIAL_QUERY_LISTENING_TOPIC_METRICS`

Aggregate metrics for one Sprout Listening Topic, optionally grouped by documented dimensions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | Metric or dimension sort expressions in field:asc or field:desc format. |
| `limit` | integer | No | Maximum number of metric objects to return. This endpoint does not paginate. |
| `filters` | array | Yes | One or more Sprout Listening filter expressions, commonly selecting created_time and network. |
| `metrics` | array | Yes | One or more documented Listening metric keys to aggregate. |
| `timezone` | string | No | ICANN time zone used to interpret date/time filters, such as America/Chicago. Response timestamps remain UTC. |
| `topic_id` | string | Yes | Listening Topic ID returned by List Customer Listening Topics. |
| `dimensions` | array | No | Documented dimensions used to bucket the aggregate metric results. |
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |
| `scale_metrics_with_reposts` | boolean | No | Whether Bluesky reposts count toward volume metrics. This option affects Bluesky only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Messages

**Slug:** `SPROUT_SOCIAL_QUERY_MESSAGES`

Retrieve one page of owned-profile inbox messages and selected metadata for a Sprout customer, with a continuation cursor when more messages are available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | Message created-time sort order. Sprout supports one ascending or descending expression. |
| `limit` | integer | No | Maximum messages to return on this page (1-100). |
| `fields` | array | No | Documented Message Fields to return. Sprout returns only guid when this is omitted. inbox_permalink requires a group_id filter. Direct-message text and metadata work, but returned DM image and video URLs do not. |
| `filters` | array | Yes | Sprout message filter expressions. Use message_id.eq(...) by itself for up to 100 message GUIDs, or combine documented group, profile, time, action, post-type, tag, language, and author filters. |
| `timezone` | string | No | ICANN time zone used to interpret date and datetime filter values, such as America/Chicago. |
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |
| `page_cursor` | string | No | Continuation cursor returned as next_cursor by a prior call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Post Analytics

**Slug:** `SPROUT_SOCIAL_QUERY_POST_ANALYTICS`

Query sent-post fields and lifetime metrics for a Sprout customer. Returns one provider page and supports Sprout's filter-encoded GUID continuation pattern for result sets beyond the 10,000-row page-mode limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | One-indexed page for page-based results. Omit when using a guid.gt(...) or guid.lt(...) deep-pagination filter. |
| `sort` | array | No | Field:direction sort expressions, such as created_time:asc. A GUID cursor requires guid:asc for guid.gt or guid:desc for guid.lt. |
| `limit` | integer | No | Number of posts to return on this page. Sprout defaults to 50 but does not document a maximum. |
| `fields` | array | No | Documented Message Fields to return. When omitted, Sprout returns guid along with the requested metrics. |
| `filters` | array | Yes | Sprout post filter expressions, typically customer_profile_id and created_time. Up to 100 profiles are supported. For deep pagination, use one standalone guid.gt(...) with guid:asc or guid.lt(...) with guid:desc, and omit page. |
| `metrics` | array | No | Optional documented network-specific lifetime post metric keys to return. Omit metrics when using a guid.gt(...) or guid.lt(...) cursor. |
| `timezone` | string | No | ICANN time zone used to interpret date/time filters, such as America/Chicago. Response timestamps remain UTC. |
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Profile Analytics

**Slug:** `SPROUT_SOCIAL_QUERY_PROFILE_ANALYTICS`

Query daily metrics for up to 100 owned social profiles over a reporting period of at most one year.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | One-indexed result page; omit to request the first page. |
| `limit` | integer | No | Number of profile metric rows to request per page. Sprout defaults to 1000 but does not document a maximum. |
| `filters` | array | Yes | Sprout filter expressions selecting customer_profile_id and reporting_period. Select at most 100 profiles and a reporting period of at most one year. |
| `metrics` | array | Yes | Network-specific profile metric keys to return. A metric must be available for each selected profile's social network and account tier. |
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Multipart Media Upload

**Slug:** `SPROUT_SOCIAL_START_MULTIPART_MEDIA_UPLOAD`

Start a Sprout multipart media submission with its first file part, or start an asynchronous download from one public media URL. A file part may be smaller than 5 MiB only when no later parts will be uploaded.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `media` | object | No | First media part, mutually exclusive with media_url. Supply at most 5 MiB (5,242,880 bytes). A part smaller than 5 MiB is valid only when it is the only and final part; otherwise the first part must be exactly 5 MiB. |
| `media_url` | string | No | Publicly reachable HTTP or HTTPS media URL for Sprout to download asynchronously; mutually exclusive with media. |
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Media

**Slug:** `SPROUT_SOCIAL_UPLOAD_MEDIA`

Upload one media file of at most 50 MiB to Sprout, or have Sprout synchronously download one public HTTP or HTTPS media URL. Uploaded media normally expires after 24 hours unless it is attached to a publishing post. Sprout accepts PNG, GIF, WebP, JPEG/HEIF-family images, common AVI/MOV/MP4/MPEG/WebM/Matroska video, SRT subtitles, and PDF documents; target social networks may impose additional restrictions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `media` | object | No | Media file to upload. Provide exactly one of media or media_url. The file must use a Sprout-supported media type and be at most 50 MiB (52,428,800 bytes). |
| `media_url` | string | No | Publicly reachable HTTP or HTTPS media URL for Sprout to download synchronously. Provide exactly one of media_url or media. |
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Multipart Media Part

**Slug:** `SPROUT_SOCIAL_UPLOAD_MULTIPART_MEDIA_PART`

Upload one subsequent non-empty chunk to an existing Sprout media submission. Part numbers begin at 2; each non-final chunk must be exactly 5 MiB, while the final chunk may be smaller.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `media` | object | Yes | Non-empty media chunk. Use exactly 5 MiB for every non-final part; the final part may contain any positive number of bytes. |
| `customer_id` | integer | Yes | Sprout customer ID returned by List Clients. |
| `part_number` | integer | Yes | Sequential part number for this chunk, starting at 2. |
| `submission_id` | string | Yes | Media submission ID returned by Start Multipart Media Upload. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
