List All Customers

GEThttps://api.omise.co/customers

Retrieve a paginated list of all customers in your account with optional filtering by date range and ordering.

---

🔑API Credentials

▼

---

Request Parameters

Additional - 2 fieldsPagination Parameters

▼

Additional - 3 fieldsFiltering & Sorting

▼

---

Responses

200

Customer list retrieved successfully

List object containing customer objects and pagination information.

Response includes:

• object - Object type (always "list")
• data - Array of customer objects
• limit - Number of items per page
• offset - Number of items skipped
• total - Total number of customers matching filters
• order - Sort order applied
• from - Start date filter applied
• to - End date filter applied

400

Bad request

Invalid parameters provided.

Common causes:

• Invalid date format (must be ISO 8601)
• Invalid order value
• Limit exceeds maximum (100)
• Negative offset value

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/customers?limit=20&offset=0&order=reverse_chronological \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

customers = Omise::Customer.list({
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

customers = omise.Customer.list(
    limit=20,
    offset=0,
    order='reverse_chronological'
)

Node.js

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

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

PHP

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

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

Java

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

ScopedList<Customer> customers = client.customers().list()
    .limit(20L)
    .offset(0L)
    .order(Ordering.ReverseChronological)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var customers = await client.Customers.List(new ListRequest
{
    Limit = 20,
    Offset = 0,
    Order = Ordering.ReverseChronological
});

Go

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

customers, _ := client.Customers().List(&operations.ListCustomers{
    List: operations.List{
        Limit:  20,
        Offset: 0,
        Order:  operations.ReverseChronological,
    },
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
bad_request	Invalid parameters	Check date format and parameter values
authentication_failure	Invalid API key	Verify your secret key is correct
invalid_parameters	Invalid pagination parameters	Check limit and offset values

List Response Fields

Field	Description
object	Object type (always "list")
data	Array of customer objects
limit	Number of items per page
offset	Number of items skipped
total	Total number of customers
order	Sort order applied
from	Start date filter
to	End date filter

---

Try it out

Additional - 5 fields

▼