---
title: "Claim status (agent)"
method: GET
path: "/v1/claim/status"
tags: ["claim"]
---

# Claim status (agent)

`GET /v1/claim/status`

## Request

- Base URL: `https://botmail.pro`
- URL: `https://botmail.pro/v1/claim/status`
- Auth: HTTP bearer

Scope: any. Pending claim keys allowed (works before and after the
claim). Poll every minute or two until `status` is `claimed`.
404 no_claim if the credential has no claim.

## Response `200`

Current claim state.

- ClaimStatus
  - `status` 'pending' | 'claimed' | 'expired', required
  - `mailbox_id` string, required
  - `address` string, email, required
  - `expires_at` string, date-time, required
  - `claimed_at` string, date-time
  - `invites_left` integer, required
  - `claim_url` string, uri: Only while pending.
  - `hint` string, required

## Other responses

- `401`: Missing or invalid credentials (`unauthorized`, `invalid_token`).
- `404`: Not found or not accessible with this credential.

---

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