Number of items to retrieve

Cursor value

Domain ID

Search filter type

• VIP: Members specified as favorite contacts

Sort by

Sort order

Bearer {token}

Member information

Response metadata

Domain ID

Member ID

Customer's member external key

Some special characters, %, \, #, /, ? are not allowed.

Indicates whether the member is the domain administrator.

Indicates whether the member is pending.

Indicates whether the member is suspended.

Indicates whether the member is deleted.

Indicates whether the member is active.

Reason for suspension

• MASTER: Suspended by the administrator.
• LOGIN_FAIL: Login failed.

Account. It is the same as the member's email address (id@domain for Standard, id@group for Advanced).

• The format is localpart@domain.
• The localpart must start with a lowercase English letter or a number.
• The localpart cannot start or end with a dot (.), and cannot contain two or more consecutive dots.
• The localpart can be between 2 and 40 characters long and can only contain English letters, numbers, dot (.), hyphen (-), and underscore (_).
• Neither "admin" nor "administrator" can be used as the localpart.

Name information

List of multilingual names

Nickname. The allowed special characters are ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~.

Personal email address.

• It is required if SSO is not enabled and passwordConfig.passwordCreationType is MEMBER.
• It is required if the member is the super admin.
• The email address must be valid. localpart@domain restrictions
• The local part can be up to 64 characters long.
• The domain name can be up to 253 characters long.

List of email aliases.

• An email alias can be up to 90 characters long.
• The format is localpart@domain.
• The localpart must start with a lowercase English letter or a number.
• The localpart cannot start or end with a dot (.), and cannot contain two or more consecutive dots.
• The localpart can be between 2 and 40 characters long and can only contain English letters, numbers, dot (.), hyphen (-), and underscore (_).

Employment type ID. Specify this parameter using the Enable employment types API operation.

• Employment type ID
• Employment type's ExternalKey (externalKey:{employmentTypeExternalKey})

Employment type external key

Employment type name

User type ID. It is available only if useUserType of the "Enable user types" API operation is "true". If not specified, "no user type" applies.

• User type ID
• User type's ExternalKey (externalKey:{userTypeExternalKey})

User type external key

User type name

User type code. It can include any combination of alphabetic characters (A-Z, a-z), numbers (0-9), or underline symbols (_) and can be up to 50 characters long. It must start with an English letter.

Indicates whether to enable auto-complete and search (default: true).

List of domains (companies) to which the member belongs, including both the primary and secondary positions.

Phone number. Only numbers with the following characters are allowed: - * # + P T ( )

Mobile phone number. Only numbers with the following characters are allowed: - * # + P T ( )

Office location

Task

Messenger information

Birthday type.

• SOLAR: Solar
• LUNAR: Lunar

Birthday in YYYY-MM-DD format

Language code

Date of hire in YYYY-MM-DD format

Timezone

Note

• Please use customProperties instead of this parameter.
• Using this parameter prevents you from accessing new features only available with the Add member custom properties API operation.

Member custom properties. You need to add a member custom property first using the Add member custom properties API operation.
The key of customProperties is the value of propertyName you specified in the Add custom field schemas API operation, which is a variable.
The value of customProperties differs in type depending on the propertyType and multiValued values of the field (see the description of each type in oneOf of CustomProperties for details). In addition, customProperties allows you to specify multiple custom properties together.

List of related contacts

Account activation date (ISO-8601 format, YYYY-MM-DDThh:mm:ssTZD)

• Can only be set to a date on or after the next day.
• Can only be set to a date within 365 days from today.
• If it is null, the account is activated immediately.

Employee number

Start time ISO-8601

End time ISO-8601

Indicates whether the member is taking a leave of absence.
It is "true" if the member is, and "false" if the member is not or a leave of absence is scheduled.

Last name. The full name can be up to 80 characters long. Either lastName or firstName must be specified. The allowed special characters are ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~.

First name. The full name can be up to 80 characters long. Either lastName or firstName must be specified. The allowed special characters are ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~.

Last name in Furigana. Katakana is allowed only.

First name in Furigana. Katakana is allowed only.

Language code

First name in the language. The last name is followed by the first name in the organization chart. The allowed special characters are ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~.

Last name in the language. The last name is followed by the first name in the organization chart. The allowed special characters are ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~.

Domain ID

Indicates whether it is the primary domain.

Make sure that you have one primary item (primary: true). If not specified, the first item automatically becomes primary.

Caution

• It references the top-level userExternalKey value instead of organizations[].userExternalKey.
• When a member is added, updated, or partially updated, the value is ignored even if it is passed.

Customer's member external key

Some special characters, %, \, #, /, ? are not allowed.

Email address.
Use this parameter to set two different email addresses for the primary and secondary positions.
Neither "admin" nor "administrator" can be used as the localpart.

Job level ID. Specify this parameter using the "Enable job levels" API operation.

• Job level ID (levelId)
• Job level's ExternalKey (externalKey:{levelExternalKey})

Customer's job level external key

Job level name

Indicates whether the member is an executive or not.

Company name

List of teams

Team ID

• Team ID (orgUnitId)
• Team's ExternalKey (externalKey:{orgUnitExternalKey})

Customer's team external key

Team name

Team email address

Indicates whether it is the primary team.

Make sure that you have one primary item (primary: true). If not specified, the first item automatically becomes primary.

Position ID. It is available only if usePosition of the "Enable Positions" API operation is "true". If not specified, "no position" applies.

• Position ID (positionId)
• Position's ExternalKey (externalKey:{positionExternalKey})

Customer's position external key

Position name

Indicates whether the member is a team leader (default: false). If it is "true" and a team leader already exists, the member replaces them, and the previous team leader is relieved of their duties.

Indicates whether to make the member visible (default: true). It indicates whether to make the member visible in the organization chart.

Indicates whether to use the team features (default: true). Use this parameter to restrict a member's use of the team features for security purposes, such as: receiving messages, sharing files and receiving team emails in the team's message room. If it is "true", the member can join the team's message room (Message/Note/Calendar/Folder) and use the following team features:

• Receive email messages sent to the team.
• Receive calendar events shared to the team.
• View the team calendar.
• View files in the drive shared to the team.
• View boards with the permissions given to the team.
• Respond to surveys of the team.
• Become a member of the groups which the team belongs to. If it is "false", all the team features described above are disabled. To prevent the member from using the team features, set this parameter to "false".

Messenger protocol

• LINE: LINE
• FACEBOOK: Facebook
• X: X (formerly Twitter)
• CUSTOM: Custom protocol

A user specified value when the protocol parameter is CUSTOM.

Messenger ID

Custom field ID

• Resource ID generated when a custom field is created.
• Customer's external key externalKey:externalKey

Custom field external key

Custom field's text to display. It is required if the custom field type is STRING.

URL when the custom field type is LINK.

• link must be specified.
• link must be set to a valid URL.
• If value is "Homepage1" and link is "https://www.unicef.org":
  <a href = "https://www.unicef.org">Homepage1</a>
• If only link is specified, it is displayed as text.

If propertyType is STRING and multiValued is false

If propertyType is STRING and multiValued is true

If propertyType is STRING, multiValued is false, and options exists, It is one of the options, optionName.

If propertyType is STRING, multiValued is true, and options exists, it is one of the options, optionName.

If propertyType is DATE and multiValued is false, it is in the YYYY-MM-DD format.

If propertyType is DATE and multiValued is true, it is in the YYYY-MM-DD format.

If propertyType is INTEGER and multiValued is false

If propertyType is INTEGER and multiValued is true

If propertyType is LINK and multiValued is false

• link must be specified.
• link must be set to a valid URL.
• If text is 'Homepage1' and link is 'https://www.unicef.org':
  <a href = "https://www.unicef.org">Homepage1</a>
• If link is specified but text is not, the link itself is displayed as the link text.

If propertyType is LINK and multiValued is true

• Either text or link or both must be specified.
• If text is 'Homepage1' and link is 'https://www.unicef.org':
  <a href = "https://www.unicef.org">Homepage1</a>
• If text is specified but link is not, no hyperlink is created.
• If link is specified but text is not, the link itself is displayed as the link text.

Text

URL

Related contact member ID

Relation name

externalKey

Cursor value for pagination