chat.bsky.convo.listConvos

bsky-lexicons.bsky.social

Documentation

Returns a page of conversations (direct or group) for the user.

main query

Returns a page of conversations (direct or group) for the user.

Parameters

cursor string Optional

No description available.

kind string Optional

Filter by conversation kind.

limit integer Optional

No description available.

lockStatus string Optional

Filter by conversation lock status. Values follow chat.bsky.convo.defs#convoLockStatus.

readState string Optional

No description available.

status string Optional

Filter convos by their status. It is discouraged to call with "request" and preferred to call chat.bsky.convo.listConvoRequests, which also includes group join requests made by the user.

Output

Encodingapplication/json
convos array Required

No description available.

cursor string Optional

No description available.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Filter by conversation kind.
Filter by conversation lock status. Values follow chat.bsky.convo.defs#convoLockStatus.
Filter convos by their status. It is discouraged to call with "request" and preferred to call chat.bsky.convo.listConvoRequests, which also includes group join requests made by the user.
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "convos"
      ],
      "properties": {
        "convos": {
          "type": "array",
          "items": {
            "ref": "chat.bsky.convo.defs#convoView",
            "type": "ref"
          }
        },
        "cursor": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "kind": {
        "type": "string",
        "description": "Filter by conversation kind.",
        "knownValues": [
          "direct",
          "group"
        ]
      },
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1
      },
      "cursor": {
        "type": "string"
      },
      "status": {
        "type": "string",
        "description": "Filter convos by their status. It is discouraged to call with \"request\" and preferred to call chat.bsky.convo.listConvoRequests, which also includes group join requests made by the user.",
        "knownValues": [
          "request",
          "accepted"
        ]
      },
      "readState": {
        "type": "string",
        "knownValues": [
          "unread"
        ]
      },
      "lockStatus": {
        "type": "string",
        "description": "Filter by conversation lock status. Values follow chat.bsky.convo.defs#convoLockStatus.",
        "knownValues": [
          "unlocked",
          "locked",
          "locked-permanently"
        ]
      }
    }
  },
  "description": "Returns a page of conversations (direct or group) for the user."
}

Lexicon Garden

@