一覧のエンドポイントの件数(cnt)・ページ番号(pageID)の仕様変更について
公開日:2026-11-17
2027年1月の正式版で、一覧を返すエンドポイントのcnt(1ページの件数)、pageID(ページ番号)、pageInfoの扱いを、コンテンツ一覧(Topics::list)に揃えます。ご利用のエンドポイントの呼び出し方をご確認のうえ、反映までに対応をお願いします。
カスタム処理でapi_internalやapi_methodを使って一覧を返すエンドポイントを呼び出している場合も対象です。
cnt=0を指定している場合
変更の内容
次のエンドポイントで、cnt=0を指定した場合に全件を返すようになります。このとき、pageInfoはtotalCntだけになり、pageIDを指定しても無視されます。エンドポイント設定のcntに0を指定した場合も同じです。現在は、cnt=0を指定した場合でも1ページ20件を返しています。
MemberCustomSearch::listMemberProvisional::listMagazineInfo::listMagazineSubscriber::listLoginHistory::listLoginFailed::listSite::listAiAgent::get_sessionsSpiderHistory::listECPoint::historyMagazine::list(エンドポイント設定のcntに0を指定した場合。クエリパラメータでcnt=0を指定した場合は、現在も全件を返しています)
TopicsCategory::listは、cnt=0を指定した場合に全件を返す動作は変わりませんが、pageInfoはtotalCntだけになります。
対応
- 現在と同じ1ページ20件で取得したい場合は、
cntに20を指定してください。 pageIDでページを送っている場合や、pageInfoのtotalCnt以外の項目を参照している場合も、cntに1以上の件数を指定してください。
最終ページより先のpageIDを指定している場合
変更の内容
一覧を返すエンドポイントで、最終ページより先のpageIDを指定すると、404エラーになります。現在は、多くのエンドポイントで最終ページ、または空の一覧を返しています。
- 件数が0件の場合は、
pageIDが2以上で404エラーになります。 cntを省略して全件を1ページで返すエンドポイント(TopicsCategory::listなど)でも、pageIDが2以上で404エラーになります。
対応
pageInfoのtotalPageCntを参照し、最終ページより先のpageIDを指定しないようにしてください。
per_page、perPage、setPerPageで件数を指定している場合
変更の内容
一覧を返すエンドポイントで、クエリパラメータのper_page、perPage、setPerPageを指定しても無視されるようになります。現在は、これらで1ページの件数を指定できるエンドポイントがあります。
対応
クエリパラメータのcntで件数を指定するように変更してください。
pageInfoの数値を文字列として扱っている場合
変更の内容
pageInfoのperPageなどの数値は、すべて整数で返すようになります。現在は、cntを指定するとperPageなどを文字列で返すエンドポイントがあります。
対応
pageInfoの数値を文字列として比較している場合は、整数として扱うように変更してください。
クエリパラメータの追加
あわせて、次のクエリパラメータを追加します。cntを省略した場合の件数は変わりません。
| エンドポイント | 追加するクエリパラメータ |
|---|---|
MemberGroup::list、Batch::list、CustomProcessing::list | cnt(1ページの件数。省略時は20件、0で全件)、pageID(ページ番号) |
反映時期
2027年1月の正式版で反映される予定です。
お問い合わせ先
本件についてご不明点がございましたら、Kurocoサポートまでお気軽にお問い合わせください。
関連ドキュメント
サポート
お探しのページは見つかりましたか?解決しない場合は、問い合わせフォームからお問い合わせいただくか、Slackコミュニティにご参加ください。