List Links

gethttps://api.nomod.com/v1/links

Fetch all links.

curl -X GET 'https://api.nomod.com/v1/links' \
  -H 'X-API-KEY: $NOMOD_API_KEY' \
  -H 'Content-Type: application/json'

Query parameters

currencystring

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

customer_idstring <uuid>

idstring

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

reference_idstring

search by link reference id

searchstring

A search term.

statusstring

link status

Enum: disabled, enabled

Responses

countintegerrequired

nextstring <uri>

previousstring <uri>

resultsarrayrequired

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "reference_id": "string",
      "title": "string",
      "url": "https://example.com",
      "amount": "0.00",
      "currency": "string",
      "status": {
        "0": "e",
        "1": "n",
        "2": "a",
        "3": "b",
        "4": "l",
        "5": "e",
        "6": "d"
      },
      "discount": "0.00",
      "service_fee": "0.00",
      "allow_tip": false,
      "shipping_address_required": false,
      "items": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "amount": "0.00",
          "name": "string",
          "total_amount": "0.00",
          "quantity": 0,
          "sku": "string"
        }
      ],
      "tax": "0.00",
      "note": "string",
      "taxes": [
        {
          "name": "string",
          "mode": "string",
          "mode_value": "0.000",
          "value": "0.000"
        }
      ],
      "discount_percentage": 0,
      "service_fee_percentage": "0.00",
      "tip": "0.00",
      "tip_percentage": 0,
      "due_date": "2026-01-01T00:00:00Z",
      "custom_fields": [
        {
          "name": "string",
          "is_required": false
        }
      ],
      "source": {
        "0": "n",
        "1": "o",
        "2": "m",
        "3": "o",
        "4": "d",
        "5": "_",
        "6": "h",
        "7": "o",
        "8": "s",
        "9": "t",
        "10": "e",
        "11": "d"
      },
      "allow_tabby": false,
      "allow_tamara": false,
      "allow_service_fee": false,
      "payment_expiry_limit": 0,
      "expiry_date": "2026-01-01"
    }
  ]
}