GET/users

ユーザーリストを取得する。

注意

  • 取得できるプロパティは、管理項目 設定などのサービスによる制約に従います。
  • Request Body における SNS タイプ messenger.protocol での TWITTER と X は、どちらも X(Twitter) を示します。TWITTER は、2026年12月上旬を目処に廃止を予定しています。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

user
user.read
directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users

Query Parameters

ParameterTypeDescription
count integer 

取得数


default : 100
minimum : 1
maximum : 100
example : 100
format : int32 
cursor string 

リストのカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
domainId integer 

ドメイン ID (既定値: 認可ドメイン ID)


example : 10000001
format : int32 
searchFilterType string 

検索フィルタリングタイプ

  • VIP : よく使う項目に指定したメンバー

Allowed values : VIP 
orderBy string 

ソートフィールド


default : CREATED_TIME
Allowed values : NAME, CREATED_TIME 
sortOrder string 

並び順


default : ASCENDING
Allowed values : ASCENDING, DESCENDING 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
users array (User) 

ユーザー

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

User

PropertyTypeDescription
domainId integer 

ドメイン ID


required
format : int32 
userId string 

ユーザー ID

  • ユーザーのリソース ID
  • 登録時に自動発行されるユニーク ID

readOnly : true 
userExternalKey string 

顧客企業で管理するユーザーの ExternalKey
"%"、"\"、"#"、"/"、"?" の特殊文字は利用できない。


maxLength : 100
nullable : true 
isAdministrator boolean 

ドメイン管理者フラグ


readOnly : true 
isPending boolean 

登録待ちステータスフラグ


readOnly : true 
isSuspended boolean 

一時停止ステータスフラグ


readOnly : true 
isDeleted boolean 

削除ステータスフラグ


readOnly : true 
isAwaiting boolean 

待機中フラグ


readOnly : true 
leaveOfAbsence object (leaveOfAbsence) 

readOnly : true 
suspendedReason string 

一時停止理由

  • MASTER : 管理者による一時停止
  • LOGIN_FAIL : ログインに失敗

Allowed values : MASTER, LOGIN_FAIL
readOnly : true
nullable : true 
email string 

ログイン ID = メールアドレス
アドバンストプランの場合、ID@ドメイン名
他のプランの場合、ID@グループ名
localpart@domain の場合の localpart の制限

  • 2 ～ 40 字の英小文字、数字、ドット (".")、ハイフン ("-")、アンダーバー ("_") のみ使用できる
  • 最初の文字には英小文字、数字のみ使用できる
  • ドット (".") は最初と最後、および連続 ("..") では使用できない
  • admin、administrator は使用できない。

required
maxLength : 90 
userName object (userName) 

名前情報


required 
i18nNames array (UserI18nName) 

多言語名リスト


minItems : 0 
nickName string 

ニックネーム

  • 許容される特殊文字: !@&()-_+[]{},./#'`^~

maxLength : 100
nullable : true 
privateEmail string 

個人メールアドレス

  • SSO を使用せず、passwordConfig.passwordCreationType が MEMBER の場合は必須
  • 最高管理者の場合は必須
  • 有効なメールアドレスを指定する
    localpart@domainの制限
  • localpart は 64 文字以下
  • domain は 253 文字以下

maxLength : 256
nullable : true 
aliasEmails array (string) 

サブメールアドレスリスト
アドバンストプランでのみ登録できる
localpart@domain の場合の localpart の制限

  • 最初の文字は英小文字、数字のみ使用できる
  • ドット (".") は最初と最後および連続 ("..")は使用できない。
  • 2 ～ 40字の英小文字、数字、ドット (".")、ハイフン ("-")、アンダーバー ("_") のみ使用できる。

minItems : 0
maxItems : 10 
employmentTypeId string 

利用権限タイプ ID
利用権限タイプ設定を使用している場合のみ指定可 (既定値: 利用権限タイプなし)

  • 利用権限タイプ ID
  • 利用権限タイプの ExternalKey (externalKey:{employmentTypeExternalKey})

注意
本プロパティは廃止予定です。今後は userTypeId を使用してください。


nullable : true 
employmentTypeExternalKey string 

利用権限タイプの ExternalKey

注意
本プロパティは廃止予定です。今後は userTypeExternalKey を使用してください。


maxLength : 100
readOnly : true
nullable : true 
employmentTypeName string 

利用権限タイプ名

注意
本プロパティは廃止予定です。今後は userTypeName を使用してください。


readOnly : true
nullable : true 
userTypeId string 

利用権限タイプ ID
利用権限タイプ設定を使用している場合のみ指定可 (既定値: 利用権限タイプなし)

  • 利用権限タイプ ID
  • 利用権限タイプの ExternalKey (externalKey:{userTypeExternalKey})

nullable : true 
userTypeExternalKey string 

利用権限タイプの ExternalKey


maxLength : 100
readOnly : true
nullable : true 
userTypeName string 

利用権限タイプ名


readOnly : true
nullable : true 
userTypeCode string 

利用権限タイプコード
英字 (A ~ Z、a ~ z)、数字 (0 ~ 9)、underscore (_) が利用でき、最大 50 文字まで指定できる。
英字で始めなければならない。


maxLength : 50
readOnly : true
nullable : true 
searchable boolean 

サジェストへの表示フラグ (既定値: true)


default : true 
organizations array (UserOrganization) 

ユーザーが所属するドメインリスト (原職、兼職含む)


minItems : 0 
telephone string 

電話番号
許容される特殊文字: -*#+P T()


maxLength : 100
pattern : ^(?=.*[0-9])[0-9+\-*#PTpt()\u3000]{0,100}
nullable : true 
cellPhone string 

携帯電話番号
許容される特殊文字: -*#+P T()


maxLength : 100
pattern : ^(?=.*[0-9])[0-9+\-*#PTpt()\u3000]{0,100}
nullable : true 
location string 

勤務先


maxLength : 100
nullable : true 
task string 

担当業務


maxLength : 100
nullable : true 
messenger object (messenger) 

SNS タイプモデル


nullable : true 
birthdayCalendarType string 

誕生日の日付タイプ

  • SOLAR : 西暦
  • LUNAR : 旧暦

Allowed values : SOLAR, LUNAR
nullable : true 
birthday string 

生年月日 (YYYY-MM-DD)


maxLength : 10
nullable : true 
locale string 

多言語コード


Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 
hiredDate string 

入社日 (YYYY-MM-DD)


maxLength : 10
nullable : true 
timeZone string 

タイムゾーン


example : Europe/Berlin 
customFields array (UserCustomField) 
  • 1 ユーザーに登録できるカスタムフィールドは最大で 50 個
  • 1 ユーザーに同一の customFieldId で登録できるカスタムフィールドは最大で 10 個

注意
本プロパティは2026年12月上旬を目処に廃止予定です。今後は customProperties を使用してください。


minItems : 0
maxItems : 50 
customProperties object (customProperties) 

ユーザーカスタムプロパティ
ユーザーカスタムプロパティの登録 を利用して、事前にカスタムフィールドを作成します。

  • customProperties の key の値は、ユーザーカスタムプロパティの登録 で設定した propertyName の値です。
  • customProperties の value の値は、フィールドの propertyType、multiValued の値によって type が異なります。詳細は customProperties を参照してください。
  • customProperties では、複数のユーザーカスタムプロパティに対する値を同時に設定することができます。
 
relations array (UserRelation) 

関係者連絡先リスト


minItems : 0
maxItems : 10 
activationDate string 

利用開始日 (形式 YYYY-MM-DDThh:mm:ssTZD)

  • 翌日以降の日付のみ指定可能です。
  • 最大365日以内の日付のみ指定可能です。
  • null の場合には、ユーザーは即時に利用可能

maxLength : 25
nullable : true 
employeeNumber string 

社員番号


minLength : 1
maxLength : 20
nullable : true 

leaveOfAbsence

PropertyTypeDescription
startTime string 

休職の開始日時 (YYYY-MM-DDThh:mm:ssTZD)


nullable : true 
endTime string 

休職の終了日時 (YYYY-MM-DDThh:mm:ssTZD)


nullable : true 
isLeaveOfAbsence boolean 

休職中フラグ

 

userName

PropertyTypeDescription
lastName string 

姓

  • 姓、名を合わせて最大 80 字まで使用できる
  • 姓と名のいずれか 1 つは必須
  • 許容される特殊文字: !@&()-_+[]{},./#'`^~

maxLength : 80
nullable : true 
firstName string 

名

  • 姓、名を合わせて最大 80 字まで使用できる
  • 姓と名のいずれか1つは必須
  • 許容される特殊文字: !@&()-_+[]{},./#'`^~

maxLength : 80
nullable : true 
phoneticLastName string 

姓のフリガナ (カタカナのみ許可)


maxLength : 100
nullable : true 
phoneticFirstName string 

名のフリガナ (カタカナのみ許可)


maxLength : 100
nullable : true 

UserI18nName

PropertyTypeDescription
language string 

多言語コード


Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 
firstName string 

多言語の名

  • 組織図の多言語の名の後ろに表示
  • 許容される特殊文字: !@&()-_+[]{},./#'`^~

maxLength : 100
nullable : true 
lastName string 

多言語の姓

  • 組織図の多言語の名の前に表示
  • 許容される特殊文字: !@&()-_+[]{},./#'`^~

maxLength : 100
nullable : true 

UserOrganization

PropertyTypeDescription
domainId integer 

ドメイン ID


required
format : int32 
primary boolean 

代表ドメインフラグ
必ず代表 (primary: true) を1つ設定してください。 代表を設定しない場合、自動的に一番最初の値が代表に設定されます。


required 
userExternalKey string 

顧客企業で管理するユーザーの ExternalKey

注意

  • organizations[].userExternalKey ではなく、user の userExternalKey の値を設定・参照してください。
  • ユーザーの登録、ユーザーの更新、ユーザーの部分更新 で organizations[].userExternalKey を指定しても、値は反映されません。
    "%"、"\"、"#"、"/"、"?" の特殊文字は利用不可。

maxLength : 100
nullable : true 
email string 

メールアドレス
アドバンストプランで原職と兼職に異なるメールアドレスを設定するときに使用。
localpart には、新たに admin、administrator を指定できない。


maxLength : 90 
levelId string 

職級 ID
職級設定を使用している場合のみ指定可 (既定値: なし)

  • 職級 ID (levelId)
  • 職級の ExternalKey (externalKey:{levelExternalKey})

nullable : true 
levelExternalKey string 

職級の ExternalKey


maxLength : 100
readOnly : true
nullable : true 
levelName string 

職級名


readOnly : true
nullable : true 
executive boolean 

役員フラグ


readOnly : true 
organizationName string 

会社名


readOnly : true 
orgUnits array (orgUnit) 

組織リスト


minItems : 0
maxItems : 30 

orgUnit

PropertyTypeDescription
orgUnitId string 

組織 ID

  • 組織 ID (orgUnitId)
  • 組織の ExternalKey (externalKey:{orgUnitExternalKey})

required 
orgUnitExternalKey string 

組織の ExternalKey


maxLength : 100
readOnly : true
nullable : true 
orgUnitName string 

組織名


readOnly : true 
orgUnitEmail string 

組織のメールアドレス


readOnly : true 
primary boolean 

代表組織フラグ
必ず代表 (primary: true )を1つ設定してください。 代表を設定しない場合、自動的に一番最初の値が代表に設定されます。


required 
positionId string 

役職 ID
役職設定を使用している場合のみ指定可 (既定値: 役職なし)

  • 役職 ID (positionId)
  • 役職の ExternalKey (externalKey:{positionExternalKey})

nullable : true 
positionExternalKey string 

役職の ExternalKey


maxLength : 100
readOnly : true
nullable : true 
positionName string 

役職名


readOnly : true
nullable : true 
isManager boolean 

組織長フラグ (既定値: false)
既存の組織長が設定されている場合は上書き (既存の組織長は解除される)。


default : false 
visible boolean 

ユーザー公開フラグ (既定値: true)
組織図から組織のユーザーとして表示するかどうか。


default : true 
useTeamFeature boolean 

組織のトークルーム機能の利用フラグ (既定値: true)
組織に所属しているがトークルームでのメッセージ受信やファイル共有、組織メール受信などの、組織のトークルーム機能を制限したい場合にこのパラメータを利用する。
この値が true の場合、以下の機能を利用可能。

  • 組織トークルームのメンバーとして参加 (トーク、ノート、カレンダー、フォルダの閲覧)
  • 組織宛メールの受信
  • 組織カレンダーの参照、および組織宛の予定招待の受信
  • 組織宛に共有された掲示板、Drive、アンケート回答
  • 組織をグループのユーザーとして設定した場合、グループのユーザーに含まれる この値が false の場合、組織に提供される上記のすべての機能は利用できない。
    組織のユーザーとして所属しているが、上記のような組織のトークルーム機能を利用しない場合、この値を false に設定する。

default : true 

messenger

PropertyTypeDescription
protocol string 

SNS タイプ

  • Request Body における SNS タイプ messenger.protocol での TWITTER と X は、どちらも X(Twitter) を示します。TWITTER は、2026年12月上旬を目処に廃止を予定しています。
  • X(Twitter) に対する Response Body の SNS タイプ messenger.protocol には、X が返ります。
  • LINE : LINE
  • FACEBOOK : Facebook
  • TWITTER : X (Twitter)
  • X : X (Twitter)
  • CUSTOM: カスタム

required
Allowed values : LINE, FACEBOOK, TWITTER, X, CUSTOM 
customProtocol string 

カスタム SNS タイプ

  • SNS タイプが CUSTOM の場合に指定する

maxLength : 100 
messengerId string 

SNS ID


required
minLength : 1
maxLength : 100 

UserCustomField

PropertyTypeDescription
customFieldId string 

カスタムフィールドを識別できる値

  • 作成時の resourceId
  • クライアントが管理するキー externalKey:{customFieldExternalKey}

required 
customFieldExternalKey string 

カスタムフィールド ExternalKey


maxLength : 100
readOnly : true
nullable : true 
value string 

カスタムフィールドテキスト

  • カスタムフィールドタイプが STRING の場合は必須

maxLength : 100
nullable : true 
link string 

カスタムフィールドリンク
カスタムフィールドタイプが LINK の場合は必須
link には有効な URL 形式を指定します。

  • value と link の両方を指定した場合 : リンク付きテキスト表示
  • link のみ指定した場合 : URL 表示

maxLength : 300
nullable : true 

customProperties

PropertyTypeDescription
propertyName string 

propertyType = STRING、multiValued = false の場合


maxLength : 100 
array (string) 

propertyType = STRING、multiValued = true の場合


maxItems : 10 
string 

propertyType = STRING、multiValued = false で、 options (選択肢リスト) が存在する場合
options (選択肢リスト) 内の optionName (選択肢名) を一つ指定する。

 
array (string) 

propertyType = STRING、multiValued = true で、 options (選択肢リスト) が存在する場合
options (選択肢リスト) 内の optionName (選択肢名) を一つ指定する。


maxItems : 10 
string 

propertyType = DATE、multiValued = false の場合。日付 (YYYY-MM-DD)


pattern : YYYY-MM-DD
format : date 
array (string) 

propertyType = DATE、multiValued = true の場合。日付 (YYYY-MM-DD)


maxItems : 10 
integer 

propertyType = INTEGER、multiValued = false の場合


minimum : 0 
array (integer) 

propertyType = INTEGER、multiValued = true の場合


maxItems : 10 
object (CustomPropertyLink) 

propertyType が LINK で、multiValued が false の場合

  • link は必須。
  • link には有効な URL 形式を指定します。
  • link のみが指定されている場合には、link が表示テキストになる。
  • text と link を両方指定し、 text が 'Homepage1'、link が 'https://www.example.com' の場合には以下となる。
    • <a href = "https://www.example.com">Homepage1</a>
 
array (CustomPropertyLink) 

propertyType = LINK で、multiValued = true の場合

  • link は必須。
  • link のみが指定されている場合には、link が表示テキストになる。
  • text と link を両方指定し、 text が 'Homepage1'、link が 'https://www.example.com' の場合には以下となる。
    • <a href = "https://www.example.com">Homepage1</a>

maxItems : 10 

CustomPropertyLink

PropertyTypeDescription
text string 

テキスト


maxLength : 100
nullable : true 
link string 

URL


maxLength : 300 

UserRelation

PropertyTypeDescription
relationUserId string 

関係者連絡先ユーザー ID

 
relationName string 

関係性


maxLength : 50 
externalKey string 

externalKey


maxLength : 100
readOnly : true
nullable : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値

 

Response Example

example

1{2  "users": [3    {4      "domainId": 10000001,5      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",6      "userExternalKey": "USER_EXT_01",7      "isAdministrator": false,8      "isPending": false,9      "isSuspended": false,10      "isDeleted": false,11      "isAwaiting": true,12      "email": "localpart@example.com",13      "userName": {14        "lastName": "ワークス",15        "firstName": "太郎"16      },17      "i18nNames": [],18      "nickName": "nickname",19      "privateEmail": "private.works@example.com",20      "aliasEmails": [],21      "searchable": true,22      "organizations": [23        {24          "domainId": 10000001,25          "primary": true,26          "email": "localpart@example.com",27          "levelId": "levelaa7-b824-4937-66af-042f1f43cefa",28          "levelName": "一般社員",29          "executive": false,30          "organizationName": "org",31          "orgUnits": [32            {33              "orgUnitId": "orgunitf-f27f-4af8-27e1-03817a911417",34              "orgUnitEmail": "team01@example.com",35              "orgUnitName": "組織01",36              "primary": true,37              "positionId": "position-7027-4a02-b838-6f52b5e38db7",38              "positionName": "社員",39              "isManager": true,40              "visible": true,41              "useTeamFeature": true42            }43          ]44        }45      ],46      "telephone": "031-1234-5678",47      "cellPhone": "090-1234-5678",48      "location": "green building",49      "task": "mytask",50      "messenger": {51        "protocol": "LINE",52        "messengerId": "lineid"53      },54      "birthdayCalendarType": "SOLAR",55      "birthday": "2000-01-01",56      "locale": "ja_JP",57      "hiredDate": "2020-01-01",58      "timeZone": "Asia/Tokyo",59      "leaveOfAbsence": {60        "isLeaveOfAbsence": false61      },62      "customProperties": {63        "string_single": "hiking",64        "string_multi": [65          "hiking",66          "swimming"67        ],68        "string_single_option": "option_cooking",69        "string_multi_option": [70          "option_cooking",71          "option_piano"72        ],73        "date_single": "2025-03-23",74        "date_multi": [75          "2025-03-23",76          "2025-03-24"77        ],78        "integer_single": 123,79        "integer_multi": [80          123,81          45682        ],83        "link_single": {84          "text": "worksmobile",85          "link": "https://contact.worksmobile.com"86        },87        "link_multi": [88          {89            "text": "worksmobile",90            "link": "https://contact.worksmobile.com"91          },92          {93            "text": "line",94            "link": "https://www.line.me/"95          }96        ]97      },98      "relations": [99        {100          "relationUserId": "userfd-fc09-4a57-ab38-03dc6c425e09",101          "relationName": "Manager",102          "externalKey": "ExternalKeyValue"103        }104      ],105      "activationDate": "2030-11-12T09:30:00+09:00",106      "employeeNumber": "employee1234"107    }108  ],109  "responseMetaData": {110    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="111  }112}