Lalexi
APIReferenceConversations

List conversations

The conversations you may open — the same ones your Lalexi conversation list shows you.

Two orders:

  • browsing (default): most recent activity first. A conversation that gets a new message while you page moves to the top, so pages may shift.
  • sync (with updated_since): oldest change first, from that moment on. A conversation that changes while you walk the pages moves to the end instead of being skipped — keep the updated_at of the last item you saw and pass it as updated_since next time.
GET
/conversations

Authorization

personalToken
AuthorizationBearer <token>

Your personal access token from Profile → Access Token in Lalexi. It acts with exactly your role: what you may see and do in the workspace, and nothing more. Everything done with it is recorded as done by you.

In: header

Query Parameters

status?string
Value in"open" | "pending" | "snoozed" | "resolved"
channel_id?integer

Only conversations of this channel.

contact_id?integer

Only conversations with this contact.

phone?string

Only conversations with the contact who has this phone number, in any formatting.

assignee_id?string

Only conversations assigned to this person, or none for unassigned ones.

team_id?integer

Only conversations of this team.

label?string

Only conversations with this label.

updated_since?string

Only conversations changed at or after this time; switches to the sync order.

Formatdate-time
limit?integer

Page size, 1–100 (values outside are brought into that range). Not a number → 422 validation_failed.

Default25
Range1 <= value <= 100
cursor?string

The next_cursor of the previous page. Opaque; a damaged cursor → 422 invalid_cursor.

Header Parameters

X-Workspace-Id?integer

The workspace to work in (an id from GET /me). Optional when you belong to a single workspace; required otherwise (400 workspace_required).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.lalexi.com/v1/conversations?phone=%2B7+900+123-45-67&assignee_id=none" \  -H "X-Workspace-Id: 7"
{
  "data": [
    {
      "id": 0,
      "status": "open",
      "priority": "low",
      "channel": {
        "id": 0,
        "name": "string",
        "type": "whatsapp"
      },
      "contact": {
        "id": 0,
        "name": "string",
        "phone": "string",
        "email": "string"
      },
      "assignee": {
        "id": 0,
        "name": "string"
      },
      "team": {
        "id": 0,
        "name": "string"
      },
      "labels": [
        "string"
      ],
      "custom_attributes": {},
      "snoozed_until": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "last_activity_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string"
}
{
  "error": {
    "code": "workspace_required",
    "message": "You belong to several workspaces: pass the X-Workspace-Id header."
  }
}
{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is missing or invalid."
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "You are not allowed to do this."
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Resource not found."
  }
}
{
  "error": {
    "code": "validation_failed",
    "message": "The request is invalid.",
    "details": {
      "email": [
        "is invalid"
      ]
    }
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the number of seconds in Retry-After."
  }
}
{
  "error": {
    "code": "internal_error",
    "message": "Something went wrong on our side."
  }
}