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
Example response
HTTP 200 OKResponse 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は相互排他的です。- ソフト削除されたアイデンティティは通常の使用を意図していません。