get_messages
Retrieve inbound social media messages with filtering options to monitor mentions, DMs, and comments across Sprout Social profiles.
Instructions
Retrieve inbound inbox messages (Smart Inbox) with optional filtering.
This endpoint returns INBOUND messages only (mentions, DMs, comments).
For OUTBOUND post counts and performance metrics, use get_post_analytics instead.
Args:
profile_ids: Comma-separated Sprout profile IDs.
start_time: Start datetime (ISO 8601, e.g. '2024-01-01T00:00:00').
end_time: End datetime (ISO 8601).
tag_ids: Comma-separated tag IDs to filter by (optional).
limit: Number of messages to return (default 50).
page_cursor: Pagination cursor from a previous response (optional).
customer_id: Sprout customer ID. Defaults to SPROUT_CUSTOMER_ID env var.Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| profile_ids | Yes | ||
| start_time | Yes | ||
| end_time | Yes | ||
| tag_ids | No | ||
| limit | No | ||
| page_cursor | No | ||
| customer_id | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |