全Recipientの一覧表示

GEThttps://api.omise.co/recipients

アカウントに属するすべてのrecipientのページネーション付きリストを取得します。結果は日付範囲でフィルタリングでき、時系列で並べ替えることができます。

---

🔑API認証情報

▼

---

リクエストパラメータ

Recommended - 5 fieldsRecommended Parameters

▼

`limit`INTEGER(optional)

ページごとに返すレコード数。

Example:20

Constraints:Minimum: 1, Maximum: 100

Default:20

`offset`INTEGER(optional)

結果を返す前にスキップするレコード数。ページネーションに使用されます。

Example:0

Default:0

`order`STRING(optional)

作成日に基づく結果の並べ替え順序。

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

`from`STRING(optional)

このUTC日時以降に作成されたrecipientをフィルタリングします。ISO 8601形式。

Example:"2025-01-01T00:00:00Z"

`to`STRING(optional)

このUTC日時以前に作成されたrecipientをフィルタリングします。ISO 8601形式。

Example:"2025-12-31T23:59:59Z"

---

レスポンス

200

成功

Recipientリストが正常に取得されました。メタデータを含むページネーションされたリストを返します。

レスポンス構造:

• object - 常に "list"
• data - recipientオブジェクトの配列
• total - フィルタに一致するrecipientの総数
• limit - ページごとのレコード数
• offset - 現在のページネーションオフセット
• from, to - 適用された日付フィルタ

400

不正なリクエスト

リクエストの検証に失敗しました。詳細についてはエラーメッセージを確認してください。

一般的な原因:

• fromまたはtoの日付形式が無効
• orderの値が無効
• offsetまたはlimitが負の値
• limitが最大値(100)を超えている

401

認証されていません

認証に失敗しました。APIキーが無効または欠落しています。

一般的な原因:

• Authorizationヘッダーが欠落している
• Secret keyが無効
• Secret keyの代わりにpublic keyを使用している
• HTTP Basic Auth形式が正しくない

---

Code samples

cURL

curl https://api.omise.co/recipients \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipients = Omise::Recipient.list(limit: 20, offset: 0)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipients = omise.Recipient.retrieve(limit=20, offset=0)

Node.js

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

const recipients = await omise.recipients.list({
  limit: 20,
  offset: 0
});

PHP

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

$recipients = OmiseRecipient::retrieve([
    'limit' => 20,
    'offset' => 0
]);

Java

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

ScopedList<Recipient> recipients = client.recipients()
    .list(new ScopedList.Options()
        .limit(20)
        .offset(0));

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var recipients = await client.Recipients.List(new ListOptions
{
    Limit = 20,
    Offset = 0
});

Go

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

recipients, _ := client.Recipients().List(&operations.ListRecipients{
    Limit:  20,
    Offset: 0,
})

---

ページネーション

limitとoffsetパラメータを使用して結果をページネーションします:

# 最初のページ (0-19)
curl https://api.omise.co/recipients?limit=20&offset=0 \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

# 2ページ目 (20-39)
curl https://api.omise.co/recipients?limit=20&offset=20 \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

---

Try it out

推奨 - 5項目

▼