すべてのCustomerのリスト表示

GEThttps://api.omise.co/customers

オプションの日付範囲フィルタリングと並べ替えを使用して、アカウント内のすべてのCustomerのページネーションされたリストを取得します。

---

🔑API認証情報

▼

---

リクエストパラメータ

追加 - 2フィールドページネーションパラメータ

▼

追加 - 3フィールドフィルタリングと並べ替え

▼

---

レスポンス

200

Customerリストが正常に取得されました

Customerオブジェクトとページネーション情報を含むlistオブジェクトです。

レスポンスに含まれるもの:

• object - オブジェクトタイプ（常に"list"）
• data - Customerオブジェクトの配列
• limit - ページごとのアイテム数
• offset - スキップされたアイテム数
• total - フィルタに一致するCustomerの総数
• order - 適用された並び順
• from - 適用された開始日フィルタ
• to - 適用された終了日フィルタ

400

不正なリクエスト

無効なパラメータが提供されました。

一般的な原因:

• 無効な日付形式（ISO 8601である必要があります）
• 無効なorder値
• limitが最大値（100）を超えています
• 負のoffset値

401

認証されていません

認証に失敗しました。API keyが無効または不足しています。

一般的な原因:

• Authorizationヘッダーが不足しています
• 無効なsecret key
• secret keyではなくpublic keyを使用しています
• HTTP Basic Auth形式が正しくありません

---

コードサンプル

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,
    },
})

---

エラーと結果コード

一般的なエラーコード

Code	Description	Resolution
bad_request	無効なパラメータ	日付形式とパラメータ値を確認してください
authentication_failure	無効なAPI key	secret keyが正しいことを確認してください
invalid_parameters	無効なページネーションパラメータ	limitとoffset値を確認してください

リストレスポンスフィールド

Field	Description
object	オブジェクトタイプ（常に"list"）
data	Customerオブジェクトの配列
limit	ページごとのアイテム数
offset	スキップされたアイテム数
total	Customerの総数
order	適用された並び順
from	開始日フィルタ
to	終了日フィルタ

---

お試しください

追加 - 5項目

▼