Skip to main content
GET
Retrieve Claim Link

Autorisationer

Authorization
string
header
påkrævet

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Sti-parametre

id
string
påkrævet

A claim-link ID (airdrp_…), or the public claim code from the c parameter in the claim URL.

Svar

claim link retrieved

A shareable link anyone holding its code can open to claim the funds.

amount
string
påkrævet

Amount each claim receives.

Eksempel:

"25.00"

claim_url
string | null
påkrævet

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

Eksempel:

"https://whop.com/claim"

claimable
boolean
påkrævet

Whether this link can currently be claimed.

Eksempel:

true

code
string | null
påkrævet

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

Eksempel:

"demoClaim123"

created_at
string<date-time>
påkrævet
Eksempel:

"2026-01-01T12:00:00.000Z"

currency
string
påkrævet
Eksempel:

"usd"

expires_at
string<date-time> | null
påkrævet
Eksempel:

"2026-01-01T12:00:00.000Z"

id
string
påkrævet

Claim-link ID, prefixed airdrp_.

Eksempel:

"airdrp_xxxxxxxxxxxxxx"

object
enum<string>
påkrævet
Tilgængelige muligheder:
claim_link
Eksempel:

"claim_link"

redeemable_count
integer
påkrævet

Maximum number of claims.

Eksempel:

1

redeemed_count
integer
påkrævet

Number of completed claims.

Eksempel:

0

remaining_claims
integer
påkrævet

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

Eksempel:

1

sender
ClaimLinkSenderAccount · object
påkrævet

The public account or user funding the claim link.

source
object
påkrævet
status
enum<string>
påkrævet

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

Tilgængelige muligheder:
pending,
fully_claimed,
canceled,
expired
Eksempel:

"pending"