List All Links

GEThttps://api.omise.co/links

Returns a paginated collection of all payment links in your account. Filter by date range and control sort order.

---

🔑API Credentials

▼

---

Request Parameters

Additional - 5 fieldsAdditional Parameters

▼

---

Responses

200

Successful retrieval

Links list retrieved successfully. Returns a paginated list with metadata.

Response structure:

• object - Always returns "list"
• data - Array of link objects
• limit - Records per page
• offset - Number of records skipped
• total - Total number of links matching filters
• order - Sort order applied
• from - Start date filter applied
• to - End date filter applied

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid date format (must be ISO 8601)
• Invalid limit value (exceeds maximum)
• Invalid order value
• Malformed parameters

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

---

Code samples

cURL

curl https://api.omise.co/links \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d "limit=20" \
  -d "offset=0" \
  -d "order=reverse_chronological"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

links = Omise::Link.list(
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

links = omise.Link.list(
    limit=20,
    offset=0,
    order='reverse_chronological'
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const links = await omise.links.list({
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$links = OmiseLink::retrieve([
    'limit' => 20,
    'offset' => 0,
    'order' => 'reverse_chronological'
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

ScopedList<Link> links = client.links().list()
    .limit(20)
    .offset(0)
    .order(Ordering.ReverseChronological)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var links = await client.Links.GetList(new ListOptions
{
    Limit = 20,
    Offset = 0,
    Order = ListOrder.ReverseChronological
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

links, _ := client.Links().List(&omise.ListParams{
    Limit:  20,
    Offset: 0,
    Order:  omise.ReverseChronological,
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
bad_request	Missing or invalid parameters	Check parameter values and formats
authentication_failure	Invalid API key	Verify your secret key is correct
invalid_date_format	Date format validation failed	Use ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)

Pagination

To paginate through results:

• Use limit to control page size (max 100)
• Use offset to skip records
• Check total in response to know total available records
• Example: Page 2 with 20 per page = offset=20&limit=20

---

Try it out

Additional - 5 fields

▼