ユーザ 一覧データの取得

登録されているユーザのデータ一覧を取得します。
ファイルのデータは POST form data として送信します。

 

  • フォーマット
エンドポイント(URL) http://flex-crm.com/<site_id>/api/v1/user
HTTPメソッド GET
リクエストヘッダ(APIキー) 認証用のAPIキー

※<site_id> は ワークスペース申込み時 に登録されている “ワークスペースID” です。

 

  • 取得できるデータ項目
status ステータス
limit 取得時のデータ制限数
offset 取得時のデータ取得位置
count 取得データ数
maxCount 総データ数
data データ情報

id:<レコード番号>
userid:<ユーザID>
name:<ユーザ表示名>
kana:<フリガナ>
employee_no:<社員番号>
mail:<メールアドレス>
status:<ステータス[1:有効 2:無効]>
del_flg:<削除フラグ[0:有効 1:削除ユーザ]>
login_date:<ログイン時刻>
last_login_date:<最終ログイン時刻>
access_time:<最終アクセス時刻>
create_user_id:<作成したユーザのレコード番号>
update_user_id:<更新したユーザのレコード番号(システム更新含む)>
update_date_for_user:<更新したユーザのレコード番号>
update_date:<最終更新日時>
create_date:<作成日時>

 

  • リクエスト例

https://flex-crm.com/flex/api/v1/user

X-FlexCRM-API-KEY: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

 

  • レスポンス例

GET https://flex-crm.com/flex/api/v1/user

{
  status: “success”,
  limit: 100,
  offset: 0,
  count: 100,
  maxCount: 1000,
  data: [
  {
    id: “1”,
    userid: “flex”,
    name: “Flex 太郎”,
    kana: “フレックス タロウ”,
    employee_no: “12345”,
    mail: “support@flex-crm.com”,
    status: “1”,
    del_flg: “0”,
    login_date: “2019-04-02 12:00:00”,
    last_login_date: “2019-04-01 16:00:00”,
    access_time: “2019-04-02 12:30:40”,
    create_user_id: “1”,
    update_user_id: “1”,
    update_date_for_user: “2019-03-20 13:30:30”,
    update_date: “2019-01-10 09:15:15”,
    create_date: “2019-01-05 09:00:00”,
  }

 

  • レスポンス例(limit=5,offset=10を指定した場合)

GET https://flex-crm.com/flex/api/v1/user?limit=5&offset=10

{
  status: “success”,
  limit: 5,
  offset: 10,
  count: 5,
  maxCount: 1000,
  data: [
  {
    id: “5”,
    userid: “flex5”,
    name: “Flex 五郎”,
    kana: “フレックス ゴロウ”,
    employee_no: “55555”,
    mail: “support@flex-crm.com”,
    status: “1”,
    del_flg: “0”,
    login_date: “2019-04-02 12:00:00”,
    last_login_date: “2019-04-01 16:00:00”,
    access_time: “2019-04-02 12:30:40”,
    create_user_id: “1”,
    update_user_id: “1”,
    update_date_for_user: “2019-03-20 13:30:30”,
    update_date: “2019-01-10 09:15:15”,
    create_date: “2019-01-05 09:00:00”,
  }

 

  • レスポンス例(ユーザIDが “flex” のデータ)

GET https://flex-crm.com/flex/api/v1/user?userid=flex
※検索値にはURLエンコードが必要となります。

{
  status: “success”,
  limit: 100,
  offset: 0,
  count: 1,
  maxCount: 1,
  data: [
  {
    id: “1”,
    userid: “flex”,
    name: “Flex 太郎”,
    kana: “フレックス タロウ”,
    employee_no: “12345”,
    mail: “support@flex-crm.com”,
    status: “1”,
    del_flg: “0”,
    login_date: “2019-04-02 12:00:00”,
    last_login_date: “2019-04-01 16:00:00”,
    access_time: “2019-04-02 12:30:40”,
    create_user_id: “1”,
    update_user_id: “1”,
    update_date_for_user: “2019-03-20 13:30:30”,
    update_date: “2019-01-10 09:15:15”,
    create_date: “2019-01-05 09:00:00”,
  }
}

 

より良いサポート情報提供のために、アンケートへのご協力をお願いします。
この情報は役に立ちましたか?

はい いいえ

0人中0人がこの情報が役に立ったと言っています。

より良いサポート情報提供のために、アンケートへのご協力をお願いします。
この情報は役に立ちましたか?

はい いいえ

0人中0人がこの情報が役に立ったと言っています。