Skip to main content
GET
Retrieve Claim Link

Autorizaciones

Authorization
string
header
requerido

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

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de ruta

id
string
requerido

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

Respuesta

claim link retrieved

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

amount
string
requerido

Amount each claim receives.

Ejemplo:

"25.00"

claim_url
string | null
requerido

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

Ejemplo:

"https://whop.com/claim"

claimable
boolean
requerido

Whether this link can currently be claimed.

Ejemplo:

true

code
string | null
requerido

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

Ejemplo:

"demoClaim123"

created_at
string<date-time>
requerido
Ejemplo:

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

currency
string
requerido
Ejemplo:

"usd"

expires_at
string<date-time> | null
requerido
Ejemplo:

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

id
string
requerido

Claim-link ID, prefixed airdrp_.

Ejemplo:

"airdrp_xxxxxxxxxxxxxx"

object
enum<string>
requerido
Opciones disponibles:
claim_link
Ejemplo:

"claim_link"

redeemable_count
integer
requerido

Maximum number of claims.

Ejemplo:

1

redeemed_count
integer
requerido

Number of completed claims.

Ejemplo:

0

remaining_claims
integer
requerido

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

Ejemplo:

1

sender
ClaimLinkSenderAccount · object
requerido

The public account or user funding the claim link.

source
object
requerido
status
enum<string>
requerido

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

Opciones disponibles:
pending,
fully_claimed,
canceled,
expired
Ejemplo:

"pending"