---
title: "Who this key is and what it may do. Call first. Free."
method: GET
path: "/v1/me"
tags: ["Guard"]
---

# Who this key is and what it may do. Call first. Free.

`GET /v1/me`

## Request

- Base URL: `https://api.layrcake.dev`
- URL: `https://api.layrcake.dev/v1/me`
- Auth: HTTP bearer

## Response `200`

Key identity, workspace, Guard limits and remaining capacity

- object
  - `key` object, required
    - `id` string, uuid, required
    - `name` string, required
    - `display_prefix` string, required
    - `created_at` string, required
    - `scopes` string[], required
    - `oauth_issued` boolean, required
  - `workspace` object, required
    - `id` string, uuid, required
    - `name` string, required
    - `risk_tier` string, required
    - `external_actions_suspended` boolean, required
  - `limits` object
    - `daily` object, required
      - `cap` integer, required
      - `ceiling` integer, required
      - `capacity` integer, required
      - `lower_cap` integer, nullable, required
      - `allocated` integer, required
      - `available` integer, required
      - `extras_today` integer, required
      - `applying` boolean, required
      - `state` 'applying' | 'applied' | 'failed'
    - `spend` object
      - `mode` 'off' | 'shadow' | 'enforce'
      - `cap_usd` string, nullable, required
      - `spent_usd` string, required
      - `inflight_usd` string
      - `left_usd` string, nullable, required
      - `left_credits` string, nullable, required
      - `state` 'ok' | 'warning' | 'stopped', required
      - `resets_at` string, date-time, required
      - `parts` object
        - `data_usd` string, required
        - `data_credits` string, required
        - `sending_usd` string, required
        - `sending_credits` string, required
        - `seat_usd` string, required
        - `agents_usd` string, required
        - `mailboxes_usd` string, required
        - `domains_usd` string, required
        - `other_usd` string, required
    - `paused` object, nullable, required
      - `by` string, required
      - `at` string, date-time, required
      - `side` 'payer' | 'client' | 'system', required
    - `campaigns` object[], required
      - `id` string, uuid, required
      - `name` string, required
      - `state` string, required
      - `share` integer, nullable, required
      - `extra_today` integer, required
      - `held_by` string[], required
      - `hold_reasons` string[], required
      - `restarting` boolean, required
      - `waiting` 'no_room' | 'removal_pending' | 'history_unavailable', nullable, required
      - `restart_no_location` integer
      - `left_by_stop` boolean
  - `guard` object, required
    - `contacted_recently_window_days` 90
    - `monthly_spend_cap` string, nullable, required
    - `spend_month_to_date` string, required
    - `spend_left` string, nullable, required
    - `workspace_daily_send_cap` integer, required
    - `daily_send_ceiling` integer
    - `daily_send_extras_today` integer
    - `daily_limits_applying` boolean
    - `workspace_spend` object, nullable
      - `mode` 'off' | 'shadow' | 'enforce'
      - `cap_usd` string, nullable, required
      - `spent_usd` string, required
      - `inflight_usd` string
      - `left_usd` string, nullable, required
      - `left_credits` string, nullable, required
      - `state` 'ok' | 'warning' | 'stopped', required
      - `resets_at` string, date-time, required
      - `parts` object
        - `data_usd` string, required
        - `data_credits` string, required
        - `sending_usd` string, required
        - `sending_credits` string, required
        - `seat_usd` string, required
        - `agents_usd` string, required
        - `mailboxes_usd` string, required
        - `domains_usd` string, required
        - `other_usd` string, required
    - `resume_available` boolean
    - `launch_recipients_admitted_today` integer, required
    - `launch_recipients_left_today` integer, required
    - `campaign_daily_capacity_allocated` integer, required
    - `campaign_daily_capacity_left` integer, required
    - `reply_daily_cap` integer, required
    - `max_replies_per_day` integer, nullable, required
    - `replies_reserved_or_sent_today` integer, required
    - `replies_left_today` integer, required
    - `max_recipients_per_action` integer, nullable, required
    - `max_assets_per_purchase` integer, nullable, required
    - `autonomous_external_actions` false, required
  - `credits` object
    - `available` string, required
    - `reserved` string, required
  - `upkeep` object
    - `state` 'free' | 'pending' | 'active' | 'grace' | 'suspended' | 'ended' | 'unknown', required
    - `paid_through` string, nullable, required
    - `grace_until` string, nullable, required
    - `rank` integer, nullable, required
    - `band` string, nullable, required
  - `billing` object
    - `live_agents` integer, required
    - `next_renewal_at` string, nullable, required
    - `next_renewal_estimate_cents` integer, required

---

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