GET
/
messages
/
:platform

Get messages or conversations for a messaging platform.

Retrieval times differ on each social network. On Facebook and Instagram, messages are available via Ayrshare in real time. On X/Twitter, there is a delay of up to 3 minutes to see the messages. Please contact support to learn more about Enterprise Plans if you need real-time X/Twitter message access.

Header Parameters

Authorization
string
required
Format: Authorization: Bearer API_KEY. See API overview for more information.
Profile-Key
string
Profile Key of a user profile.

Path Parameters

platform
string
required

The platform to get the message: facebook, instagram, twitter

Query Parameters

status
string
default: "active"required

Return active conversations or archived conversations. Values: active or archived.

conversationId
string

Only return the specific conversation.

conversationsOnly
boolean
default: false

Return all the conversations. If true then conversationId field ignored.