表示モード

全ユーザー一覧取得API ​

全ユーザー一覧取得APIは、システム管理者の権限でユーザーの一覧を取得するAPIです。

※ 「全ユーザー一覧取得API」が利用可能に設定されているAPIアクセスキーを使用する必要があります。

リクエスト内容 ​

フィールド名フィールド値備考
actionlist_users必須

「全ユーザー一覧取得API」であることを示します。
access_tokenAPIアクセスキー必須

システム管理者のAPIアクセスキーの取得方法はこちらを参照してください。
limit1～100の数値任意
未指定時：100

最大取得件数を指定できます。
0以下の値や100より大きい値を指定した場合は100として扱われます。
offset0以上の数値任意
未指定時：0

取得開始位置を指定できます。
q検索したい文字列任意
未指定時：検索条件なし

ユーザー名・ふりがな・メールアドレスを部分一致で検索できます。
group組織のシステムID｜no_organization任意
未指定時：絞り込みなし

指定した組織で絞り込むことができます。
組織に所属していないユーザーのみを取得したい場合は、no_organizationを指定してください。
組織のシステムIDの取得方法はこちらを参照してください。
※ 組織のシステムIDは12桁の英数字です。例：1z68b0kdhr5z
user_typeguest任意
未指定時：絞り込みなし

指定したユーザータイプで絞り込むことができます。
ゲストユーザーのみを取得したい場合は、guestを指定してください。
user_stateavailable任意
未指定時：絞り込みなし

指定したユーザー状態で絞り込むことができます。
利用可能ユーザーのみを取得したい場合は、availableを指定してください。
sortdisplay_order｜name｜group任意
未指定時：display_order

指定した項目でソートできます。
表示順の場合はdisplay_order、ユーザー名順はname、組織順はgroupを指定してください。
orderasc｜desc任意
未指定時：asc

sort(ソート対象)パラメータで指定した順序を並び替えることができます。
昇順の場合はasc、降順の場合はdescを指定してください。

データ取得に関する制限事項

取得対象のデータ数がlimit未満の場合は、offsetは0になります。
例：limit=100で取得対象のデータ数が80件なら、offset=10と指定しても80件のデータを取得します。

制限事項ページ

リクエストの例 ​

sh
curl -X POST "https://your.domain/cgi-bin/chatlk/managerApi.cgi"
-F "action=list_users"
-F "access_token=(APIアクセスキー)"
-F "limit=10"
-F "offset=0"

※ リクエスト先のURLは、お客様の環境に書き換えてください。
　 詳しくはリクエスト先のURLを参照してください。

レスポンス内容 ​

フィールド名フィールド値、意味
resultok=成功、ng=失敗
server_time成功した時のサーバー時間
offset取得開始行数
all_count取得したユーザー情報の件数
list.item取得したユーザー情報の配列
※ ユーザー情報1件の内容は以下の表を参照してください。

ユーザー情報1件の内容 ​

フィールド名フィールド値、意味
user_idユーザーのシステムID
user_nameユーザー名
other_nameふりがな
user_typeinner=組織内ユーザー、guest=ゲストユーザー
※ 組織の所属有無にかかわらず、ゲストユーザーを除くすべてのユーザーを「組織内ユーザー」として扱います。
user_stateavailable=利用可能、unavailable=利用停止
login_blockedon=ログイン拒否中、off=ログイン可能
guest_group_nameゲストユーザーが所属している組織
group_list.itemユーザーが所属している組織情報の配列
※ 所属組織情報1件の内容は以下の表を参照してください。

所属組織情報1件の内容 ​

フィールド名フィールド値、意味
group_id所属組織のシステムID
group_name所属組織の名前
is_mainon=代表組織
※ 代表組織である場合にのみ含まれます。代表組織でない場合は含まれません。

※ result以外の値はresult=okのときのみ含まれます。

※ result=ngのときのレスポンスについては共通仕様を参照してください。

レスポンス内容の例 ​

jsonc
// Content-Type: application/json
{
  "result": "ok",
  "server_time": "2025-01-20T12:30:45",
  "offset": "0",
  "all_count": "100",
  "list": {
    "item": [
      {
        "user_id": "1z68b0kdhr5z",
        "user_name": "責任者",
        "other_name": "せきにんしゃ",
        "user_type": "inner",
        "user_state": "available",
        "login_blocked": "off",
        "guest_group_name": "",
        "group_list": {
          "item": [
            {
              "group_id": "000000000001",
              "group_name": "情報システム室",
              "is_main": "on"
            },
            {
              "group_id": "1wkmq7ltrvo4",
              "group_name": "サンプル組織"
            }
          ]
        }
      },
      // 以降は省略
    ]
  }
}
Copyright © 2015-2026 NEOJAPAN Inc. All Rights Reserved.