Sign in
Transfers

Retrieve Claim Link

Changed on

Retrieves a funded claim link by ID or by its public claim code. By ID, the caller needs airdrop_link:basic:read on the funding account, or must own the funding personal account; code and claim_url are null without airdrop_link:manage on the funding account or payout:withdraw_funds on the personal account. A claim code previews the sender, amount, expiry, and claim availability without authentication. Treat codes as secrets: anyone holding one can claim after signing in.

get/claim_links/{id}

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/claim_links/{id}
  • Auth: one of:
    • none
    • HTTP bearer
    • HTTP bearer

Response

claim link retrieved

amountstring required

Amount each claim receives.

claim_urlstring nullable required

Shareable claim URL. Null when retrieving by ID without claim-link management access.

claimableboolean required

Whether this link can currently be claimed.

codestring nullable required

Redeemable claim code. Null when retrieving by ID without claim-link management access.

created_atstring date-time required
currencystring required
expires_atstring date-time nullable required
idstring required

Claim-link ID, prefixed airdrp_.

object'claim_link' required
redeemable_countinteger required

Maximum number of claims.

redeemed_countinteger required

Number of completed claims.

remaining_claimsinteger required

Number of available claims, excluding slots reserved by pending claims.

status'pending' | 'fully_claimed' | 'canceled' | 'expired' required

The link's lifecycle status. A newly funded link is pending. Check claimable for current availability, including expiry and reserved claims.

Example response

{
  "amount": "25.00",
  "claim_url": "https://whop.com/claim",
  "claimable": true,
  "code": "demoClaim123",
  "created_at": "2026-01-01T12:00:00.000Z",
  "currency": "usd",
  "expires_at": "2026-01-01T12:00:00.000Z",
  "id": "airdrp_xxxxxxxxxxxxxx",
  "object": "claim_link",
  "redeemable_count": 1,
  "remaining_claims": 1,
  "sender": {
    "id": "biz_xxxxxxxxxxxxxx",
    "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/shine-time-logo",
    "object": "account",
    "route": "biz_xxxxxxxxxxxxxx",
    "title": "Shine Time Auto Detailing"
  },
  "source": {
    "account_id": "biz_xxxxxxxxxxxxxx"
  },
  "status": "pending"
}

Changes

  • 06a445f7fe04Revision changes
    • info

      the security scope airdrop_link:basic:read was added to the endpoint's security scheme bearerAuth

  • face599bc329Revision changes
    • info

      the security scope airdrop_link:basic:read was added to the endpoint's security scheme bearerAuth