GET/directory/custom-fields

カスタムフィールドリストを取得する。

注意
この API は2026年7月下旬を目処に提供終了を予定しています。今後は ユーザーカスタムプロパティリストの取得 を使用してください。

Authorization

oauth2

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

Scope

directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/directory/custom-fields

Query Parameters

ParameterTypeDescription
domainId integer 

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


example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
customFields array (CustomField) 

カスタムフィールドリスト

 

CustomField

PropertyTypeDescription
domainId integer 

ドメイン ID


required
format : int32 
customFieldId string 

カスタムフィールド ID

  • カスタムフィールドのリソース ID
  • 登録時に自動発行されるユニーク ID

readOnly : true 
customFieldExternalKey string 

カスタムフィールドキー (更新不可)
ドメイン内で一意
英数字のみ使用可能 (最初の文字は英字)
大文字小文字は区別しない


maxLength : 100
nullable : true 
customFieldName string 

カスタムフィールド名
ドメイン内で一意。


required
maxLength : 20 
customFieldType string 

カスタムフィールドタイプ (更新不可)

  • STRING : テキスト
  • LINK : URL

required
Allowed values : STRING, LINK 
displayOrder integer 

表示順位 (重複許可)
値を入力しない (NULL) 場合、最後尾に指定される。


format : int32 

Response Example

example

1{2  "customFields": [3    {4      "domainId": 10000001,5      "customFieldId": "customfd-fc09-4a57-ab38-03dc6c425e09",6      "customFieldExternalKey": "CUSTOMFIELDEXT01",7      "customFieldName": "custom01",8      "customFieldType": "LINK",9      "displayOrder": 110    }11  ]12}

HTTP 404

Not Found