# at.happyproto.actor.getProfile

> Published by [happyproto.at](https://lexicon.garden/identity/did:plc:mo7vq4jbioxwafy5zkcc3eux)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.actor.getProfile)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.actor.getProfile/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.actor.getProfile/examples)

## Definitions

### `at.happyproto.actor.getProfile`

**Type**: `query`

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.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `actor` | `string` (at-identifier) | No | Handle or DID to look up. Defaults to the authenticated caller. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `access` | `string` | No | Caller only. Access level in the HappyProto admin space. |
| `avatar` | `string` (uri) | No |  |
| `did` | `string` (did) | Yes |  |
| `displayName` | `string` | No |  |
| `handle` | `string` (handle) | No |  |
| `isCustomer` | `boolean` | No | Caller only. Whether the actor is a member of the customers space, the same rule the customer endpoints apply. |
| `isMember` | `boolean` | No | Caller only. Whether the actor may use the dashboard. |
| `isSelf` | `boolean` | Yes | Whether this profile is the authenticated caller's. When false, the entitlement fields are absent — they are never populated for another actor. |

#### Errors

- **AuthRequired**: This endpoint requires an authenticated caller.
- **Forbidden**: Declared for the customer gate the script consults; getProfile never returns it, since a refused gate reports isCustomer false.
- **ActorNotFound**: The requested actor could not be resolved.

## Raw Schema

```json
{
  "$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
}
```