---
title: "Return the caller profile + tenant + scopes"
method: GET
path: "/api/v1/me"
tags: ["Me"]
---

# Return the caller profile + tenant + scopes

`GET /api/v1/me`

## Request

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

Returns the caller's user_id, workspace (tenant_id), plan, role (admin/member) and effective scopes. Session (JWT) callers only.

## Response `200`

Caller profile

- ApiResponseMeResponse
  - `success` boolean, required
  - `data` MeResponse: Caller profile + tenant resolution.
    - `user_id` string, required
    - `email` string, nullable, required
    - `role` 'admin' | 'member', nullable, required: Role within the workspace. Null if the user has no workspace (every new account gets a personal workspace, so this should not occur).
    - `tenant_id` string, nullable, required
    - `tenant_name` string, nullable, required
    - `tenant_plan` string, nullable, required: The workspace's plan: 'free', 'builder', 'team', or 'enterprise'.
    - `scopes` string[]: Scopes the caller's plan opens. A session is gated on them exactly like an API key; there is no implicit access.
  - `error` ApiError: API error details.
    - `code` string, required
    - `message` string, required
    - `details` object, nullable
  - `meta` ApiMeta: API response metadata. Pagination fields (``page`` / ``per_page`` / ``total``) are populated on collection endpoints only. They are omitted from the payload on single-resource endpoints.
    - `timestamp` string, date-time
    - `request_id` string, nullable
    - `page` integer, nullable
    - `per_page` integer, nullable
    - `total` integer, nullable
  - `links` ApiLinks: HATEOAS-style pagination cursors. Host-relative path + query links for a collection page. Present on collection endpoints, ``null`` fields where a page doesn't exist (``next`` on the last page, ``prev`` on the first). The whole ``links`` object is omitted from single-resource responses (see ``ApiResponse`` serializer).
    - `self` string, nullable
    - `first` string, nullable
    - `prev` string, nullable
    - `next` string, nullable
    - `last` string, nullable

## Other responses

- `401`: Unauthenticated

---

[API](https://skmtc.dev/hub-equity/apis/hub-equity-api.md) · [All operations](https://skmtc.dev/hub-equity/apis/hub-equity-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hub-equity/apis/hub-equity-api/revisions/e8eeda5dc13e?raw)