List Links

GET /v1/links

Fetch all links.

Request

X-API-KEYstringheaderrequired

Your API key. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the app settings

allow_tipbooleanquery

Allow Tip

currencystringquery

currency code i-e AED, fetch the currency code from /currencies apis

customer_idstring<uuid>query

idstringquery

pageintegerquery

A page number within the paginated result set.

page_sizeintegerquery

Number of results to return per page.

reference_idstringquery

search by link reference id

searchstringquery

A search term.

shipping_address_requiredbooleanquery

Allow Shipping Address

statusstringquery

link status