GET
/
v1
/
links
/
{uuid}
curl --request GET \
  --url https://api.nomod.com/v1/links/{uuid} \
  --header 'X-API-KEY: <api-key>'
{
  "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

Path Parameters

​
uuid
string
required

Response

200
application/json
​
id
string
required
​
reference_id
string
required
​
title
string
required
​
url
string
required
​
amount
string
required
​
currency
string
required
​
status
enum<string>
required
  • enabled - enabled
  • disabled - disabled
Available options:
enabled,
disabled
​
discount
string
required
​
service_fee
string
required
​
allow_tip
boolean
required
​
shipping_address_required
boolean
required
​
items
object[]
required
​
tax
string
required
​
note
string
required
​
taxes
object[]
required
​
discount_percentage
integer
required
​
service_fee_percentage
string
required
​
tip
string
required
​
tip_percentage
integer
required
​
custom_fields
object[]
required
​
source
enum<string>
required
  • woocommerce - WooCommerce
  • zapier - Zapier
  • nomod_api - API
  • pages - Pages
  • app - App
  • web - Web
Available options:
woocommerce,
zapier,
nomod_api,
pages,
app,
web
​
pages_url
object
required
Create LinkUpdate Link