The API reference moved here from eksis.io/developers.
Conversations

List conversations

GET
/v1/conversations

Direct message conversations, the most recently active first. Reading them never marks anything read. Direct messages start on the Starter plan.

Authorization

headerAuthorizationBearer <token>

Send your key as Authorization: Bearer eksis_sk_....

Query Parameters

status?string
Value in"all""open""assigned""done"
channels?string

Comma-separated channel ids.

q?string

Text in the contact name or username.

limit?integer

Rows per page. Values above 100 are clamped to 100.

Range1 <= value <= 100
Default25
cursor?string

The nextCursor from the previous page, unchanged.

Response Body

One page of conversations.

application/json
  1. response
data?array<>
nextCursor?|

Pass back as cursor for the next page. null means this was the last page.

curl -X GET 'https://api.eksis.io/v1/conversations' \  -H 'Authorization: Bearer eksis_sk_...'
{  "data": [    {      "id": "string",      "channelId": "string",      "platform": "string",      "contact": {        "name": "string",        "username": "string"      },      "status": "open",      "unreadCount": 0,      "lastMessageAt": "2019-08-24T14:15:22Z",      "lastMessagePreview": "string",      "replyWindow": {        "state": "open",        "expiresAt": "2019-08-24T14:15:22Z"      }    }  ],  "nextCursor": "string"}