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

# アイデンティティ一覧を取得する

> カーソルページネーションを使用して、現在のアカウント配下の Forward アイデンティティを一覧表示します。

`GET /api/v1/forward/identities`

認証されたアカウントが所有する Identity レコードを返します。

## Headers

| Header          | Required | Description    |
| --------------- | -------- | -------------- |
| `Authorization` | Yes      | `Bearer <PAT>` |

## Query parameters

| Parameter     | Type    | Required | Default | Description                                    |
| ------------- | ------- | -------- | ------- | ---------------------------------------------- |
| `external_id` | string  | No       | -       | インテグレーターのエンドユーザー ID でフィルタリングします。               |
| `limit`       | integer | No       | 20      | 1 ページあたりの項目数。最大 100。100 を超える値は HTTP 400 を返します。 |
| `after_id`    | string  | No       | -       | 次のページのカーソル。`before_id` と併用できません。               |
| `before_id`   | string  | No       | -       | 前のページのカーソル。`after_id` と併用できません。                |

## Example request

```bash theme={null}
curl -s -X GET 'https://api.qoder.com/api/v1/forward/identities?external_id=user_456&limit=20' \
  -H "Authorization: Bearer $QODER_PAT"
```

## Example response

**HTTP 200 OK**

```json theme={null}
{
  "data": [
    {
      "id": "idn_019eabc123",
      "external_id": "user_456",
      "name": "Example User",
      "enabled": true,
      "metadata": {},
      "created_at": "2026-06-18T10:00:00Z",
      "updated_at": "2026-06-18T10:00:00Z"
    }
  ],
  "first_id": "idn_019eabc123",
  "last_id": "idn_019eabc123",
  "has_more": false
}
```

## Response fields

| Field      | Type         | Description                |
| ---------- | ------------ | -------------------------- |
| `data`     | array        | 現在のページにある Identity オブジェクト。 |
| `first_id` | string\|null | このページの最初のレコードの ID。         |
| `last_id`  | string\|null | このページの最後のレコードの ID。         |
| `has_more` | boolean      | さらにレコードが残っているかどうか。         |

## Errors

| HTTP | Type                    | Trigger                                     |
| ---- | ----------------------- | ------------------------------------------- |
| 400  | `invalid_request_error` | ページネーションパラメータが無効、または `limit` が 100 を超えています。 |
| 401  | `authentication_error`  | PAT が無効または期限切れです。                           |
| 403  | `permission_error`      | このリソースへのアクセス権がありません。                        |

## Notes

* `after_id` と `before_id` は相互排他的です。
* ソフト削除されたアイデンティティは通常の使用を意図していません。

## Related

<CardGroup cols={2}>
  <Card title="アイデンティティを作成する" icon="plus" href="/cloud-agents/api/forward/identities/create" />

  <Card title="アイデンティティを取得する" icon="file-lines" href="/cloud-agents/api/forward/identities/get" />
</CardGroup>
