social.coves.community.list

List communities with various sorting options. Authentication optional; viewer state will be included if authenticated.

Repository @coves.social did:web:coves.social namespace authority
Details · query
Kindquery
Authoritycommunity.coves.social
Indexed
cid bafyreie6knbysmh6vj3o2z2jxoxz3y7eiywethkq3l3t2i7fbchnxals5e

Checks

Valid Lint pass
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "List communities with various sorting options. Authentication optional; viewer state will be included if authenticated.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "communities": {
              "items": {
                "ref": "social.coves.community.defs#communityView",
                "type": "ref"
              },
              "type": "array"
            },
            "cursor": {
              "maxLength": 500,
              "type": "string"
            }
          },
          "required": [
            "communities"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "category": {
            "description": "Filter by category",
            "maxLength": 50,
            "type": "string"
          },
          "cursor": {
            "description": "Pagination cursor",
            "maxLength": 500,
            "type": "string"
          },
          "language": {
            "description": "Filter by language",
            "format": "language",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "sort": {
            "default": "popular",
            "description": "Sorting method",
            "knownValues": [
              "popular",
              "active",
              "new",
              "alphabetical"
            ],
            "maxLength": 64,
            "type": "string"
          },
          "subscribed": {
            "description": "If true, only return communities the viewer is subscribed to. Requires authentication.",
            "type": "boolean"
          },
          "visibility": {
            "description": "Filter communities by visibility level",
            "knownValues": [
              "public",
              "unlisted",
              "private"
            ],
            "maxLength": 64,
            "type": "string"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "social.coves.community.list",
  "lexicon": 1
}