GET
/
v1
/
links
curl --request GET \
  --url https://api.nomod.com/v1/links \
  --header 'X-API-KEY: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reference_id": "<string>",
      "title": "<string>",
      "url": "<string>",
      "amount": "<string>",
      "currency": "<string>",
      "status": "enabled",
      "discount": "<string>",
      "service_fee": "<string>",
      "allow_tip": true,
      "shipping_address_required": true,
      "items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": "<string>",
          "name": "<string>",
          "total_amount": "<string>",
          "quantity": 2147483647,
          "sku": "<string>"
        }
      ],
      "tax": "<string>",
      "note": "<string>",
      "taxes": [
        {
          "name": "<string>",
          "mode": "<string>",
          "mode_value": "0.000",
          "value": "0.000"
        }
      ],
      "discount_percentage": 123,
      "service_fee_percentage": "<string>",
      "tip": "<string>",
      "tip_percentage": 123,
      "custom_fields": [
        {
          "name": "<string>",
          "is_required": true
        }
      ],
      "source": "woocommerce",
      "pages_url": {}
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

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

Query Parameters

​
allow_tip
boolean

Allow Tip

​
currency
string

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

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
reference_id
string

search by link reference id

​
shipping_address_required
boolean

Allow Shipping Address

​
status
enum<string>

link status

Available options:
disabled,
enabled

Response

200 - application/json
​
count
integer
Example:

123

​
next
string | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string | null
Example:

"http://api.example.org/accounts/?page=2"

​
results
object[]