social.colibri.beta.actor.getProfile Documentation (EN)

main query

Gets a user's profile.

Parameters

actor string at-identifier Required

The user's DID or handle.

Output

Encodingapplication/json

profile refsocial.colibri.beta.actor.defs#profileView Required

The user's profile.

Errors

AuthRequired The request has no valid service auth.

ActorNotFound No user matches the given DID or handle.

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

actor * The user's DID or handle.

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request has no valid service auth."
    },
    {
      "name": "ActorNotFound",
      "description": "No user matches the given DID or handle."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "profile"
      ],
      "properties": {
        "profile": {
          "ref": "social.colibri.beta.actor.defs#profileView",
          "type": "ref",
          "description": "The user's profile."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "actor"
    ],
    "properties": {
      "actor": {
        "type": "string",
        "format": "at-identifier",
        "description": "The user's DID or handle."
      }
    }
  },
  "description": "Gets a user's profile."
}