> ## Documentation Index
> Fetch the complete documentation index at: https://docs.livingsecurity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ページネーション

> リストのエンベロープ、limit パラメーター、不透明な page_token カーソルを使用して、Living Security Public API のリストを順に取得します。

すべての `/v1` リストエンドポイントは、同一のエンベロープを返し、同一の方式（トークンベースの前方専用）でページネーションを行います。

## リストのエンベロープ

```json theme={null}
{
  "object": "list",
  "data": [
    {
      "id": "ent_8f3d2c1b0a9e",
      "object": "entity",
      "type": "person",
      "status": "active",
      "display_name": "Dana Rivera",
      "email": "dana.rivera@example.com",
      "created_at": "2025-11-03T09:21:44.000Z",
      "updated_at": "2026-07-28T16:02:10.000Z"
    }
  ],
  "next_page_token": "eyJvcmdhbml6YXRpb2...",
  "has_more": true
}
```

<ResponseField name="object" type="string">
  常に `"list"` です。
</ResponseField>

<ResponseField name="data" type="array">
  リソースのページです。安定した決定論的な順序で返されます。
</ResponseField>

<ResponseField name="next_page_token" type="string | null">
  次のページを取得するには、次のリクエストでこの値を `page_token` として渡します。
  これ以上結果がない場合は `null` になります。
</ResponseField>

<ResponseField name="has_more" type="boolean">
  このページより後にさらに結果が存在するかどうかを示します。
</ResponseField>

## リクエストパラメーター

<ParamField query="limit" type="integer" default="25">
  ページサイズです。1 から 500 までの整数を指定します。この範囲外の値を指定すると、コード `invalid_request` の `400` が返されます。
</ParamField>

<ParamField query="page_token" type="string">
  前回のレスポンスに含まれる `next_page_token` です。最初のページでは省略します。
</ParamField>

オフセットパラメーター、前のページへの移動、正確な総件数はありません。コレクションの件数を数えるには、コレクションを順に取得してください。

<Note>
  **例外:** `GET /v1/cohorts/{id}/members` は、`limit` にそれより大きい値を指定した場合でも、1 ページあたり最大 50 行までしか返しません。`has_more` と `next_page_token` は、引き続きコホートの実際の残りを反映します。
</Note>

いずれかの Basic 認証情報の形式で認証してください。詳細は [クイックスタート](/ja/developers/v1/quickstart)（`apikey:secret` または `secret:`）を参照してください。
`BASE` には、組織のリージョン別ホストを設定してください。詳細は [リージョン](/ja/developers/v1/regions) を参照してください。

## リストを順に取得する

クイックスタートと同様に、シークレットマネージャーから `LIVING_SECURITY_API_KEY` を読み込みます。
この例では `entity:read` が必要です。最初のリクエストのガイドで使用したキーには、この追加の権限付与が必要になる場合があります。Python の例では `requests` を、シェルの例では `jq` をインストールしてください。どちらの例もバージョンを固定し、フィルターを変更せず、リダイレクトを拒否します。エラーが発生した場合、および 1,000 ページに達した場合は処理を停止し、一部のみの取得を完了として報告することはありません。Python の読み取りタイムアウトは、処理全体の所要時間ではなく、無通信時間を制限するものです。ジョブ全体の期限は、お使いの連携側で設定してください。

`next_page_token` が `null` になるまでページをリクエストします。一括読み取りでは、より少ないリクエスト数でコレクション全体を取得できるよう、`limit=500` を推奨します。詳細は [レート制限](/ja/developers/v1/rate-limits) を参照してください。

<CodeGroup>
  ```bash cURL + jq theme={null}
  set -euo pipefail
  # US: BASE="https://api.us-east-1.livingsecurity.ai/v1"
  BASE="https://api.eu-west-1.livingsecurity.ai/v1"
  : "${LIVING_SECURITY_API_KEY:?Set LIVING_SECURITY_API_KEY}"
  TOKEN=""

  # Bound each run. Increase this page budget deliberately for larger collections.
  for ((page_number=1; page_number<=1000; page_number++)); do
    PARAMS=(--data-urlencode "limit=500" --data-urlencode "type=person")
    if [ -n "$TOKEN" ]; then
      PARAMS+=(--data-urlencode "page_token=$TOKEN")
    fi
    RESULT=$(curl --silent --show-error --fail-with-body \
      --connect-timeout 5 --max-time 30 --get \
      -u "apikey:$LIVING_SECURITY_API_KEY" \
      -H "Living-Security-Version: 2026-07-01" \
      --write-out '\n%{http_code}' "${PARAMS[@]}" "$BASE/entities")
    STATUS="${RESULT##*$'\n'}"
    PAGE="${RESULT%$'\n'*}"
    [ "$STATUS" = "200" ] || { echo "Unexpected HTTP status: $STATUS" >&2; exit 1; }
    jq -e 'has("next_page_token") and .object == "list" and (.data | type == "array") and
      ((.has_more == false and .next_page_token == null) or
       (.has_more == true and (.next_page_token | type == "string" and length > 0)))' \
      <<< "$PAGE" > /dev/null
    NEXT=$(jq -r '.next_page_token // empty' <<< "$PAGE")
    [ -z "$NEXT" ] || [ "$NEXT" != "$TOKEN" ] || { echo "Repeated page token" >&2; exit 1; }
    jq -r '.data[].id' <<< "$PAGE"
    [ -n "$NEXT" ] || exit 0
    TOKEN="$NEXT"
  done
  echo "Page budget exhausted; the collection is incomplete" >&2
  exit 1
  ```

  ```python Python theme={null}
  import os
  import requests

  # US: BASE = "https://api.us-east-1.livingsecurity.ai/v1"
  BASE = "https://api.eu-west-1.livingsecurity.ai/v1"
  AUTH = ("apikey", os.environ["LIVING_SECURITY_API_KEY"])

  def iter_entities(*, entity_type="person", max_pages=1000):
      if type(max_pages) is not int or max_pages < 1:
          raise ValueError("max_pages must be a positive integer")
      params = {"limit": 500, "type": entity_type}
      for _ in range(max_pages):
          response = requests.get(
              f"{BASE}/entities",
              auth=AUTH,
              params=params,
              headers={"Living-Security-Version": "2026-07-01"},
              timeout=(5, 30),
              allow_redirects=False,
          )
          try:
              response.raise_for_status()
              if response.status_code != 200:
                  raise RuntimeError("Unexpected response; check your regional API URL")
              page = response.json()
          finally:
              response.close()
          if (not isinstance(page, dict) or page.get("object") != "list"
                  or not isinstance(page.get("data"), list)
                  or type(page.get("has_more")) is not bool
                  or "next_page_token" not in page):
              raise RuntimeError("Invalid list response")
          token = page["next_page_token"]
          if ((page["has_more"] and (not isinstance(token, str) or not token))
                  or (not page["has_more"] and token is not None)):
              raise RuntimeError("Inconsistent list response")
          if token is not None and token == params.get("page_token"):
              raise RuntimeError("Repeated page token")
          yield from page["data"]
          if token is None:
              return
          params = {**params, "page_token": token}
      raise RuntimeError("Page budget exhausted; the collection is incomplete")

  if __name__ == "__main__":
      for entity in iter_entities():
          print(entity["id"])
  ```
</CodeGroup>

## ページネーション中はフィルターを固定する

ページトークンは、署名された不透明なカーソルです。各トークンは、それを発行したリクエストの組織、認証済みのサービスアカウント、契約バージョン、および正確なフィルターセットに紐づけられています。たとえば 2 ページ目で `type` フィルターを追加するなど、順次取得の途中でこれらのいずれかを変更すると、`page_token` パラメーターに対してコード `invalid_request` の `400` が返されます。

```json 400 Invalid request theme={null}
{
  "type": "https://docs.livingsecurity.com/developers/v1/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "page_token does not match this request's organization, credential, contract version, or filters.",
  "code": "invalid_request",
  "param": "page_token",
  "request_id": "req_...",
  "doc_url": "https://docs.livingsecurity.com/developers/v1/errors/invalid_request",
  "retryable": false
}
```

フィルターを変更するには、最初のページから新たに取得をやり直してください。

<Tip>
  `page_token` は不透明な文字列として扱い、受け取ったとおりに返してください。トークンをデコードしたり、長期間保存したり、自分で生成したりしないでください。内部形式は予告なく変更されることがあります。
</Tip>

<Note>
  リストエンドポイントは、サポートしていないクエリパラメーターが指定されると、そのパラメーターを示す `400` `invalid_request` を返して拒否します。サポートされているフィルターについては、各エンドポイントのリファレンスを確認してください。
</Note>

## 中断された、または変化するコレクションへの対処

これらの例では、エラーを自動的に再試行しません。`429` の場合は、`Retry-After` に従い、制限付きの[再試行ガイダンス](/ja/developers/v1/rate-limits)に従ってください。読み取りを再試行する際は、同じリージョン、サービスアカウント、バージョン、フィルター、および最後に正常に処理したページトークンを使用してください。認証情報を変更してもアクセス権は付与されません。各リクエストでは、常に現在の権限が確認されます。

複数ページにわたる読み取りは、コレクションのスナップショットではありません。取得している間にも行が変更される可能性があります。リソースは安定した `id` で処理し、下流への書き込みは冪等にしてください。再開すると、同じ行が再び返されることがあります。トークンが拒否された場合は、`page_token` エラーを確認し、リクエストを修正してから最初のページからやり直してください。処理済みのデータを黙って破棄したり、中断されたエクスポートを完了としてマークしたりしないでください。正確な集計値が必要な場合は、ライブのリスト取得をスナップショットとして扱うのではなく、適切なレポートリソースを使用してください。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.