Lexicon Garden

at.happyproto.actor.getProfile

Get an actor's profile. Returns full detail — including dashboard entitlements — only for the authenticated caller; for any other actor it returns public basics only.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · query
Kindquery
Authorityactor.happyproto.at
Indexed
Compare Edit in builder → Fork →
cid bafyreidepgfhkragts2pvaumcsiupgcm7jfry2j7bijp7wpkfxhf5aty2q

Checks

Valid
  • unlimited-string defs.main.output.schema.properties.accessNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.displayNameNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Get an actor's profile. Returns full detail — including dashboard entitlements — only for the authenticated caller; for any other actor it returns public basics only.",
      "errors": [
        {
          "description": "This endpoint requires an authenticated caller.",
          "name": "AuthRequired"
        },
        {
          "description": "Declared for the customer gate the script consults; getProfile never returns it, since a refused gate reports isCustomer false.",
          "name": "Forbidden"
        },
        {
          "description": "The requested actor could not be resolved.",
          "name": "ActorNotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "access": {
              "description": "Caller only. Access level in the HappyProto admin space.",
              "knownValues": [
                "read",
                "write"
              ],
              "type": "string"
            },
            "avatar": {
              "format": "uri",
              "type": "string"
            },
            "did": {
              "format": "did",
              "type": "string"
            },
            "displayName": {
              "type": "string"
            },
            "handle": {
              "format": "handle",
              "type": "string"
            },
            "isCustomer": {
              "description": "Caller only. Whether the actor is a member of the customers space, the same rule the customer endpoints apply.",
              "type": "boolean"
            },
            "isMember": {
              "description": "Caller only. Whether the actor may use the dashboard.",
              "type": "boolean"
            },
            "isSelf": {
              "description": "Whether this profile is the authenticated caller's. When false, the entitlement fields are absent — they are never populated for another actor.",
              "type": "boolean"
            }
          },
          "required": [
            "did",
            "isSelf"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "actor": {
            "description": "Handle or DID to look up. Defaults to the authenticated caller.",
            "format": "at-identifier",
            "type": "string"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "at.happyproto.actor.getProfile",
  "lexicon": 1
}