Get a group

GET /api/2.0/groups/{id}

Request

Returns the detailed information about the selected group.

Note: This method returns full group information.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Path

idstringformat: uuidrequired

Group ID

Query

includeMembersboolean

Include members

Examples

GET /api/2.0/groups/6b0809de-873c-4bde-b351-22ffca648213?includeMembers=true HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url 'https://example.com/api/2.0/groups/6b0809de-873c-4bde-b351-22ffca648213?includeMembers=true' \
  --header 'Accept: application/json'

Responses

200

Group with the detailed information

namestring

Name

parentstringformat: uuid

Parent

categorystringformat: uuid

Category

idstringformat: uuid

ID

isLDAPboolean

Specifies if the LDAP settings are enabled for the group or not

managerobject

idstringformat: uuid

displayNamestring

titlestring

avatarstring

avatarOriginalstring

avatarMaxstring

avatarMediumstring

avatarSmallstring

profileUrlstring

hasAvatarboolean

isAnonimboolean

firstNamestring

lastNamestring

userNamestring

emailstringformat: email

contactsarray of unknown

birthdayobject

utcTimestringformat: date-time

timeZoneOffsetstringformat: date-span

sexstring

statusone of

.enum of string

[Active - Active, Terminated - Terminated, Pending - Pending, Default - Default, All - All]

Can be one of: Active, Terminated, Pending, Default, All.

.enum of integer

[1 - Active, 2 - Terminated, 4 - Pending, 5 - Default, 7 - All]

Can be one of: 1, 2, 4, 5, 7.

activationStatusone of

.enum of string

[NotActivated - Not activated, Activated - Activated, Pending - Pending, AutoGenerated - Auto generated]

Can be one of: NotActivated, Activated, Pending, AutoGenerated.

.enum of integer

[0 - Not activated, 1 - Activated, 2 - Pending, 4 - Auto generated]

Can be one of: 0, 1, 2, 4.

terminatedobject

utcTimestringformat: date-time

timeZoneOffsetstringformat: date-span

departmentstring

workFromobject

utcTimestringformat: date-time

timeZoneOffsetstringformat: date-span

groupsarray of unknown

locationstring

notesstring

isAdminboolean

isRoomAdminboolean

isLDAPboolean

listAdminModulesarray of unknown

isOwnerboolean

isVisitorboolean

isCollaboratorboolean

cultureNamestring

mobilePhonestring

mobilePhoneActivationStatusone of

.enum of string

[NotActivated - Not activated, Activated - Activated]

Can be one of: NotActivated, Activated.

.enum of integer

[0 - Not activated, 1 - Activated]

Can be one of: 0, 1.

isSSOboolean

themeone of

.enum of string

[Base - Base, Dark - Dark, System - System]

Can be one of: Base, Dark, System.

.enum of integer

[0 - Base, 1 - Dark, 2 - System]

Can be one of: 0, 1, 2.

quotaLimitintegerformat: int64

usedSpacenumberformat: double

sharedboolean

isCustomQuotaboolean

loginEventIdintegerformat: int32

membersarray of unknown

List of members

sharedboolean

Shared

membersCountintegerformat: int32

Members count

401

Unauthorized

403

Forbidden