---
title: "Describe the calling credential"
method: GET
path: "/v1/me"
tags: ["me"]
---

# Describe the calling credential

`GET /v1/me`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/me`
- Auth: HTTP bearer

Returns who is calling and what they are allowed to do: whether the caller is a signed-in person, an API key, or Brix support; the location an API key is pinned to, if any; the workspace; and the caller's full set of permissions.

Who is calling (API key, user, or Brix support), which workspace the call resolves to, and the permissions held. Call it first when a request is refused: `actor.nodeId` shows a key pinned to one location.

## Response `200`

Success.

- object
  - `data` object, required
    - `actor` union, required: The credential making the call: an API key, a user session, or Brix support.
      - object
        - `kind` 'key', required
        - `id` string, nullable, required: API key id.
        - `name` string, nullable, required: The key's name.
        - `nodeId` string, nullable, required: The location the key is pinned to; null = workspace-wide. A pinned key cannot see or create outside that subtree.
      - object
        - `kind` 'user', required
        - `id` string, nullable, required
        - `name` string, nullable, required
        - `email` string, nullable, required
        - `nodeId` unknown, required
      - object
        - `kind` 'staff', required
        - `id` string, required: `staff:<email>` — Brix support opened the workspace as the customer.
        - `name` 'Brix staff', required
        - `email` string, required
        - `nodeId` unknown, required
    - `workspace` WorkspaceRef, required
      - `id` string, required: Workspace id.
      - `name` string, nullable, required: Workspace name; null only if the workspace row is missing.
    - `permissions` union, required: `all` for an owner-style credential, else every `resource.verb` held anywhere in the workspace. A planning hint: node-scoped checks still run on each call.
      - 'all'
      - string[]
    - `paymentRequired` object, nullable, required: Set when every seat this person holds is in a location that pays before it goes live and has not paid yet: they can read, and add a card with `POST /v1/org-nodes/{id}/payment/checkout`; every other write answers 402 `payment_required`. Null otherwise.
      - `spaceId` string, required: The location (child workspace) that waits for its payment.
      - `spaceName` string, required
      - `canPay` boolean, required: True when this person can add the card (`billing.edit` at that location).

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)