> ## 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.

# Paginação

> Percorra as listas da API pública da Living Security com o envelope de lista, o parâmetro limit e cursores opacos page_token.

Todo endpoint de lista `/v1` retorna o mesmo envelope e pagina da mesma
forma: baseada em token e somente para frente.

## O envelope de lista

```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">
  Sempre `"list"`.
</ResponseField>

<ResponseField name="data" type="array">
  A página de recursos, em uma ordem estável e determinística.
</ResponseField>

<ResponseField name="next_page_token" type="string | null">
  Envie este valor como `page_token` na próxima solicitação para obter a página seguinte.
  `null` quando não houver mais resultados.
</ResponseField>

<ResponseField name="has_more" type="boolean">
  Indica se existem mais resultados além desta página.
</ResponseField>

## Parâmetros da solicitação

<ParamField query="limit" type="integer" default="25">
  Tamanho da página. Um número inteiro entre 1 e 500. Valores fora desse intervalo retornam um
  `400` com o código `invalid_request`.
</ParamField>

<ParamField query="page_token" type="string">
  O `next_page_token` da resposta anterior. Omita-o na primeira página.
</ParamField>

Não há parâmetros de deslocamento (offset), nem navegação para a página anterior, nem contagens totais exatas. Para contar uma coleção, percorra-a.

<Note>
  **Exceção:** `GET /v1/cohorts/{id}/members` retorna no máximo 50 linhas por
  página, mesmo que você solicite um `limit` maior. `has_more` e
  `next_page_token` continuam refletindo o restante real da Coorte.
</Note>

Autentique-se com qualquer um dos dois formatos de credencial Basic — consulte o
[Início rápido](/pt-BR/developers/v1/quickstart) (`apikey:secret` ou `secret:`).
Defina `BASE` como o host regional da organização — consulte
[Regiões](/pt-BR/developers/v1/regions).

## Percorrendo uma lista

Carregue `LIVING_SECURITY_API_KEY` a partir do seu gerenciador de segredos, como no início rápido.
Este exemplo requer `entity:read`; a chave usada no guia da primeira solicitação pode
precisar dessa concessão adicional. Instale `requests` para Python ou `jq` para o exemplo
em shell. Ambos os exemplos fixam uma versão, mantêm os filtros inalterados e rejeitam
redirecionamentos. Eles param em caso de erro e após 1.000 páginas, em vez de informar como concluída uma
varredura parcial. O tempo limite de leitura do Python limita a inatividade, não a duração total
da tarefa; defina um prazo para a tarefa em sua integração.

Solicite páginas até que `next_page_token` seja `null`. Prefira `limit=500` para leituras
em massa, de modo a cobrir a coleção com menos solicitações — consulte os
[limites de taxa](/pt-BR/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>

## Mantenha os filtros estáveis durante a paginação

Os tokens de página são cursores opacos e assinados. Cada token está vinculado à
organização, à conta de serviço autenticada, à versão do contrato e ao
conjunto exato de filtros da solicitação que o gerou. Alterar qualquer um desses itens no meio da varredura — por
exemplo, adicionar um filtro `type` na segunda página — retorna um `400` com o código
`invalid_request` no parâmetro `page_token`:

```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
}
```

Para alterar os filtros, inicie uma nova varredura a partir da primeira página.

<Tip>
  Trate `page_token` como uma string opaca: envie-o de volta exatamente como foi recebido.
  Não decodifique, não armazene a longo prazo e não construa tokens — o formato interno deles
  pode mudar a qualquer momento, sem aviso prévio.
</Tip>

<Note>
  Os endpoints de lista rejeitam parâmetros de consulta que não suportam com um `400`
  `invalid_request` que indica o nome do parâmetro. Consulte a referência de cada endpoint para
  saber quais filtros são suportados.
</Note>

## Lidar com uma coleção interrompida ou em alteração

Estes exemplos não tentam novamente, de forma automática, as solicitações com erro. Para `429`, respeite `Retry-After`
e siga as [orientações de nova tentativa](/pt-BR/developers/v1/rate-limits) limitadas. Mantenha a
mesma região, conta de serviço, versão, filtros e o último token de página processado com êxito ao tentar novamente uma leitura. Trocar as credenciais não concede acesso:
cada solicitação ainda verifica as permissões atuais.

Uma leitura de várias páginas não é um instantâneo da coleção. As linhas podem mudar enquanto
você a percorre. Processe os recursos pelo `id` estável e torne as
gravações posteriores idempotentes; uma reinicialização pode retornar uma linha novamente. Se um token for rejeitado,
examine o erro `page_token` e corrija a solicitação antes de reiniciar a partir da
primeira página. Não descarte silenciosamente dados já processados nem marque uma
exportação interrompida como concluída. Para totais exatos de relatórios, use o
recurso de relatórios apropriado em vez de tratar uma varredura de lista em tempo real como um instantâneo.


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