Login / Register
GET
/api/public/v1/conversations

List conversations

The channels, direct messages and group chats the token’s employee belongs to, most recent activity first, each with that person’s own read state. Membership is the access rule rather than the scope: this is that person’s inbox, not the company’s, and a channel they are not in is simply absent. `threads:admin` additionally keeps archived channels visible, so a moderator can still reach one to restore it. `title` is derived rather than stored — a DM or group has no name of its own, so it is built from who is in it, from the reader’s point of view. A DIRECT or GROUP conversation somebody opened in the composer but never sent to stays invisible to everyone but its initiator until the first message goes. `unreadCount` is the number the Threads rail shows for the conversation: messages from other people after `lastReadAt`, thread replies included, never system lines (“X started a huddle”) and never your own. A `lastReadAt` of null means nothing has been read, so everything counts. `markedUnread` is the manual “Mark as unread” flag and stands on its own when nobody has written yet. `unreadThreadCount` is how many threads have replies you have not opened — a muted or archived conversation reports 0, as it contributes nothing to Catch-up. `unread=true` is the Catch-up rule: unread messages or `markedUnread`, and never a muted conversation. Rows still carry the raw `unreadCount`.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

threads:read

Query Parameters

NameTypeRequiredDescription
limitnumberOptionalMaximum number of items to return (1-100).Default: 20
offsetnumberOptionalNumber of items to skip before starting to collect the result set.Default: 0
sortBystringOptionalField to sort by. Allowed values vary by endpoint.Default: createdAt
sortOrderstring
asc
desc
OptionalSort direction.Default: desc
searchstringOptionalFree-text search across the resource’s primary fields.
createdAfterstringOptionalISO 8601 timestamp — only return items created after this time.
createdBeforestringOptionalISO 8601 timestamp — only return items created before this time.
updatedAfterstringOptionalISO 8601 timestamp — only return items updated after this time.
typestring
CHANNEL
DIRECT
GROUP
OptionalCHANNEL is a named room; DIRECT is 1:1; GROUP is a multi-person DM. Case-insensitive, and `dm` is accepted for DIRECT. Anything else is a 400.
unreadbooleanOptional`true` keeps conversations with unread messages or a manual unread flag (never a muted one); `false` keeps the rest.
isArchivedbooleanOptionalArchived channels are visible only with `threads:admin`; without it, `true` returns nothing and archived channels are never listed.
favoritebooleanOptionalOnly the conversations this person has starred, or only those they have not.
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/conversations" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Conversations retrieved successfully!",
  "content": {
    "conversations": [
      {
        "id": "cnv_5150",
        "referenceId": 88,
        "type": "CHANNEL",
        "title": "engineering",
        "name": "engineering",
        "topic": "Shipping things",
        "description": null,
        "visibility": "PUBLIC",
        "isArchived": false,
        "lastMessageAt": "2026-08-29T18:22:00.000Z",
        "isSupport": false,
        "isCrossCompany": false,
        "memberEmployeeIds": [
          "emp_12ab",
          "emp_44f1"
        ],
        "createdAt": "2026-01-08T09:00:00.000Z",
        "isMember": true,
        "unreadCount": 3,
        "unreadThreadCount": 1,
        "lastReadAt": "2026-08-29T17:58:00.000Z",
        "markedUnread": false,
        "isMuted": false,
        "isFavorite": true
      }
    ],
    "pagination": {
      "total": 42,
      "limit": 20,
      "offset": 0,
      "hasMore": true
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Threads
/threads