メインコンテンツへスキップ
GET /api/v1/forward/identities 認証されたアカウントが所有する Identity レコードを返します。

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT>

Query parameters

ParameterTypeRequiredDefaultDescription
external_idstringNo-インテグレーターのエンドユーザー ID でフィルタリングします。
limitintegerNo201 ページあたりの項目数。最大 100。100 を超える値は HTTP 400 を返します。
after_idstringNo-次のページのカーソル。before_id と併用できません。
before_idstringNo-前のページのカーソル。after_id と併用できません。

Example request

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
{
  "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

FieldTypeDescription
dataarray現在のページにある Identity オブジェクト。
first_idstring|nullこのページの最初のレコードの ID。
last_idstring|nullこのページの最後のレコードの ID。
has_morebooleanさらにレコードが残っているかどうか。

Errors

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

Notes

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

アイデンティティを作成する

アイデンティティを取得する