Get Conversations — POST /api/v1/get-conversations

Use this endpoint to retrieve all conversation threads associated with your Botsify bot. You can paginate through results using the page parameter, and narrow the response down to a specific messaging channel by passing a source filter. Authentication is handled either via a request body apikey field or the X-Api-Key header.

Request

integer

The page number to retrieve for paginated results. Defaults to the first page when omitted.

string

Filter conversations by the originating channel. Accepted values include messenger, web, and other supported channel identifiers.

string

Your bot’s API key. You may alternatively supply this value in the X-Api-Key request header instead of the body.

Example Request

curl --request POST \
  --url https://app.botsify.com/api/v1/get-conversations \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: YOUR_BOT_API_KEY' \
  --data '{
    "page": 1,
    "source": "messenger"
  }'

Response

A successful request returns a JSON object containing a paginated array of conversation thread records. Each conversation object includes the thread identifier, channel source, the last message timestamp, and participant details. The response also includes pagination metadata such as the current page and total number of conversations available.

{
  "data": [
    {
      "id": "conv_001",
      "source": "messenger",
      "last_message_at": "2024-01-15T10:30:00Z",
      "user": {
        "fbId": "user-123",
        "name": "Jane Doe"
      }
    }
  ],
  "current_page": 1,
  "total": 150
}

Authorization

Bots & Agents

Agent Versions

Messaging

Users & Analytics

WhatsApp

Get Conversations — POST /api/v1/get-conversations

Request

Example Request

Response

​Request

​Example Request

​Response

Request

Example Request

Response