dev.cartridge.actor.getProfile Documentation (EN)

main query

Get a Cartridge profile with roles. Wraps games.gamesgamesgamesgames.getProfile and appends a roles array.

Parameters

handle string at-identifier Optional

Either a DID or an AT Protocol handle.

Output

Encodingapplication/json

handle stringhandle Optional

An AT Protocol handle (e.g., alice.bsky.social).

profile union Optional

No description available.

profileType string Optional

No description available.

Known values: actor, org

roles array Optional

No description available.

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

handle Either a DID or an AT Protocol handle.

View raw schema

{
  "description": "Get a Cartridge profile with roles. Wraps games.gamesgamesgamesgames.getProfile and appends a roles array.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "handle": {
          "format": "handle",
          "type": "string"
        },
        "profile": {
          "refs": [
            "games.gamesgamesgamesgames.defs#actorProfileDetailView",
            "games.gamesgamesgamesgames.defs#orgProfileDetailView"
          ],
          "type": "union"
        },
        "profileType": {
          "knownValues": [
            "actor",
            "org"
          ],
          "maxLength": 64,
          "type": "string"
        },
        "roles": {
          "items": {
            "knownValues": [
              "superadmin",
              "admin"
            ],
            "type": "string"
          },
          "type": "array"
        }
      },
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "handle": {
        "format": "at-identifier",
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}