net.atpix.gallery.listCollectionRules

lexicon.atpix.net

Documentation

List collection rules owned by the authenticated user.

main query

List collection rules owned by the authenticated user.

Parameters

activeOnly boolean Optional

No description available.

cursor string Optional

No description available.

limit integer Optional

No description available.

targetScope ref Optional

No description available.

Output

Encodingapplication/json
cursor string Optional

No description available.

rules array Required

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
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "rules"
      ],
      "properties": {
        "rules": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "uri",
              "cid",
              "author",
              "record"
            ],
            "properties": {
              "cid": {
                "type": "string",
                "format": "cid"
              },
              "uri": {
                "type": "string",
                "format": "at-uri"
              },
              "author": {
                "type": "string",
                "format": "did"
              },
              "record": {
                "type": "object",
                "required": [
                  "name",
                  "targetScope",
                  "createdAt"
                ],
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "active": {
                    "type": "boolean"
                  },
                  "hashtags": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "createdAt": {
                    "type": "string",
                    "format": "datetime"
                  },
                  "modifiedAt": {
                    "type": "string",
                    "format": "datetime"
                  },
                  "description": {
                    "type": "string"
                  },
                  "targetScope": {
                    "ref": "net.atpix.gallery.defs#targetScope",
                    "type": "ref"
                  },
                  "followedActors": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "format": "did"
                    }
                  },
                  "targetAlbumUri": {
                    "type": "string",
                    "format": "at-uri"
                  },
                  "useFollowGraph": {
                    "type": "boolean"
                  },
                  "includeOwnPhotos": {
                    "type": "boolean"
                  }
                }
              }
            }
          }
        },
        "cursor": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "limit": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1
      },
      "cursor": {
        "type": "string"
      },
      "activeOnly": {
        "type": "boolean",
        "default": true
      },
      "targetScope": {
        "ref": "net.atpix.gallery.defs#targetScope",
        "type": "ref"
      }
    }
  },
  "description": "List collection rules owned by the authenticated user."
}

Lexicon Garden

@