ドキュメントAPI リファレンスレート制限・ページネーション

レート制限・ページネーション

APIのレート制限とページネーションの仕様です。

レート制限

レート制限はエンドポイントの種類ごとに設定されており、ご契約内容による差はありません。

対象リクエスト上限集計単位
公開API(/api/v1/*)60リクエスト / 1分間組織ごと
SCIMプロビジョニング30リクエスト / 1分間組織トークンごと

認証・アップロード・一括処理など一部のエンドポイントには、これとは別のより厳しい制限が設定されています。 レート制限の値は予告なく調整されることがあります。上限に達した場合は 429 が返ります。 429 を受け取った場合は、しばらく待ってから間隔を空けてリトライしてください(現在、X-RateLimit-* や Retry-After などのレート制限ヘッダーは提供していません)。

ページネーション

一覧を返すエンドポイント(/api/v1/projects・/api/v1/staff)はページ番号方式です。

パラメータ既定値説明
page1ページ番号(1始まり)
perPageprojects: 20 / staff: 501ページあたりの件数(最大100)
// リクエスト
GET /api/v1/projects?page=2&perPage=20

// レスポンス
{
  "data": [...],
  "pagination": {
    "page": 2,
    "perPage": 20,
    "total": 45
  }
}

pagination.total は絞り込み後の全件数です。page × perPage が total を超えるまでpage を増やして取得してください。