---
title: "Claim link details (human)"
method: GET
path: "/v1/claim/info"
tags: ["claim"]
---

# Claim link details (human)

`GET /v1/claim/info`

## Request

- Base URL: `https://botmail.pro`
- URL: `https://botmail.pro/v1/claim/info`
- Auth: one of:
  - none
  - API key in cookie `bm_session`

No auth needed. Used by the claim page. Signed-in humans also get
`can_accept` (and `plan_limit` when their plan is full).
404 claim_not_found. Rate limit: 30/minute per IP.

## Query parameters

- `token` string, required

## Response `200`

Claim details.

- ClaimInfo
  - `address` string, email, required
  - `agent_name` string, required
  - `status` 'pending' | 'claimed' | 'expired', required
  - `expires_at` string, date-time, required
  - `can_accept` boolean: Signed-in humans only
  - `plan_limit` Error
    - `code` string, required: Stable machine-readable code, e.g. `not_found`, `name_taken`, `rate_limited`.
    - `message` string, required
    - `hint` string: What to do next.
    - `details` object

## Other responses

- `404`: Not found or not accessible with this credential.
- `429`: Too many requests (`rate_limited`, `invite_limit`). Wait `Retry-After` seconds.

---

[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)