com.atiproto.recipient.profile.get Documentation (EN)

main query

Get the authenticated user's profile settings. Returns defaults if no profile exists.

Output

Encodingapplication/json

cid stringcid Optional

Profile record CID (absent if no profile configured)

hasProfile boolean Required

Whether the user has saved a profile record

profile refcom.atiproto.profile#view Required

The profile record data (defaults if not configured)

readyForPayment boolean Required

Whether the user's payment account is set up and enabled

uri stringat-uri Optional

Profile record URI (absent if no profile configured)

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)

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "profile",
        "hasProfile",
        "readyForPayment"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid",
          "description": "Profile record CID (absent if no profile configured)"
        },
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "Profile record URI (absent if no profile configured)"
        },
        "profile": {
          "ref": "com.atiproto.profile#view",
          "type": "ref",
          "description": "The profile record data (defaults if not configured)"
        },
        "hasProfile": {
          "type": "boolean",
          "description": "Whether the user has saved a profile record"
        },
        "readyForPayment": {
          "type": "boolean",
          "description": "Whether the user's payment account is set up and enabled"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Get the authenticated user's profile settings. Returns defaults if no profile exists."
}