Domain ID

Number of items to get

Cursor

Bearer {token}

Group information

Response metadata

Domain ID

It is automatically assigned.

Group name. It must be unique within the domain.

Group description

Indicates whether to make the group visible. It indicates whether to make the group visible in search results for users who are not managers or members.

Indicates whether to send service notifications.

Indicates whether a group master can change whether to use the service.

Group external key

List of group masters

List of group members

Indicates whether to use the Message Room features.

• If it is set to "false", the chat history of all the members is deleted and the Message Room features (Note, Calendar, Folder, and Task) are disabled after 30 days.
• Set this parameter to "true" again within 30 days to recover the previous data. Setting it to "true" after 30 days cannot recover the previous data; it only creates a new message room.

Indicates whether to use the Message Room Note feature.

• If it is set to "false", the feature is disabled. To view the previous data, set this parameter to "true".
• This parameter is available only if useMessage is "true".

Indicates whether to use the Message Room Calendar feature.

• If it is set to "false", the feature is disabled. To view the previous data, set this parameter to "true".
• This parameter is available only if useMessage is "true".

Indicates whether to use the Message Room Task feature.

• If it is set to "false", the feature is disabled. To view the previous data, set this parameter to "true".
• This parameter is available only if useMessage is "true".

Indicates whether to use the Message Room Folder feature.

• If it is set to "false", the feature is disabled. To view the previous data, set this parameter to "true".
• This parameter is available only if useMessage is "true".

Indicates whether to use group emails.

• Available only for the Advanced plan.
• If this parameter is "true", groupEmail is required.

Group email address (if useMail is "true").

• The format is localpart@domain.
• The localpart must start with a lowercase English letter, a number, an exclamation mark (!), or a number sign (#).
• The localpart cannot start or end with a dot (.), and cannot contain two or more consecutive dots.
• The localpart can be between 2 and 64 characters long and can only contain lowercase English letters, numbers, dot (.), hyphen (-), underscore (_), exclamation mark (!), and number sign (#).

Group email alias (if useMail is "true").

• Each email address can be up to 90 characters long.
• The format is localpart@domain.
• The localpart must start with a lowercase English letter, a number, an exclamation mark (!), or a number sign (#).
• The localpart cannot start or end with a dot (.), and cannot contain two or more consecutive dots.
• The localpart can be between 2 and 64 characters long and can only contain lowercase English letters, numbers, dot (.), hyphen (-), underscore (_), exclamation mark (!), and number sign (#).

Indicates whether to receive external emails (if useMail is "true").

External email addresses to receive group emails.
Email addresses with your company domain are not allowed.

Members who can send an email to the group email address (if useMail is "true").
Only the group emails sent from the specified members are allowed.

Members who can use the group email address as their From address (if useMail is "true").
Only the group masters or members are allowed. (Those who are not the members or administrators of the group will be excluded from the list).

Indicates whether to enable dynamic membership.

• If it is set to "true", group members are automatically added or removed based on query conditions.
• If dynamic membership is enabled, the specified members field is ignored because group members are automatically added or deleted.

Dynamic membership

Member external key

Member ID
- Email address
- Resource ID
- External key in "externalKey:{externalKey}" format

Member external key

Member, team, or group ID.
The following types are available for a member ID:
- Email address
- Resource ID
- External key in "externalKey:{externalKey}" format

Member external key

Member ID
- Email address
- Resource ID
- External key in "externalKey:{externalKey}" format

Membership query.
For how to create a query, see Overview.

List of member IDs to exclude from the group. The following types are available:

• Mail
• Resource ID
• External key in "externalKey:{externalKey}" format

Cursor value for pagination