Get a group

GET /api/2.0/group/{id}

Request

Returns the detailed information about the selected group.

Note: 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/group/7127dfce-ffa5-46bf-9b99-27fe61e70b8d?includeMembers=true HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url 'https://example.com/api/2.0/group/7127dfce-ffa5-46bf-9b99-27fe61e70b8d?includeMembers=true' \
  --header 'Accept: application/json'

Responses

200

Group with the detailed information

namestring

Name

parentstringformat: uuid

Parent

categorystringformat: uuid

Category

idstringformat: uuid

isLDAPboolean

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

managerobject

idstringformat: uuid

displayNamestring

Display name

titlestring

Title

avatarstring

Avatar

avatarOriginalstring

Original size avatar

avatarMaxstring

Maximum size avatar

avatarMediumstring

Medium size avatar

avatarSmallstring

Small avatar

profileUrlstring

Profile URL

hasAvatarboolean

Specifies if the user has an avatar or not

isAnonimboolean

Specifies if the user is an anonim or not

firstNamestring

First name

lastNamestring

Last name

userNamestring

Username

emailstringformat: email

contactsarray of object

List of contacts

typestring: Contact type
valuestring: Contact value

birthdayobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

sexstring

Sex

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: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

departmentstring

Department

workFromobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

groupsarray of object

List of groups

idstringformat: uuid: ID
namestring: Name
managerstring: Manager

locationstring

Location

notesstring

Notes

isAdminboolean

Specifies if the user is an administrator or not

isRoomAdminboolean

Specifies if the user is a room administrator or not

isLDAPboolean

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

listAdminModulesarray of string

List of administrator modules

isOwnerboolean

Specifies if the user is a portal owner or not

isVisitorboolean

Specifies if the user is a portal visitor or not

isCollaboratorboolean

Specifies if the user is a portal collaborator or not

cultureNamestring

Language

mobilePhonestring

Mobile phone number

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

Specifies if the SSO settings are enabled for the user or not

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

Quota limit

usedSpacenumberformat: double

Portal used space

sharedboolean

Shared

isCustomQuotaboolean

Specifies if the user has a custom quota or not

loginEventIdintegerformat: int32

Current login event ID

createdByobject

idstringformat: uuid: ID
displayNamestring: Display name
titlestring: Title
avatarstring: Avatar
avatarOriginalstring: Original size avatar
avatarMaxstring: Maximum size avatar
avatarMediumstring: Medium size avatar
avatarSmallstring: Small avatar
profileUrlstring: Profile URL
hasAvatarboolean: Specifies if the user has an avatar or not
isAnonimboolean: Specifies if the user is an anonim or not

registrationDateobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

membersarray of object

List of members

idstringformat: uuid

displayNamestring

Display name

titlestring

Title

avatarstring

Avatar

avatarOriginalstring

Original size avatar

avatarMaxstring

Maximum size avatar

avatarMediumstring

Medium size avatar

avatarSmallstring

Small avatar

profileUrlstring

Profile URL

hasAvatarboolean

Specifies if the user has an avatar or not

isAnonimboolean

Specifies if the user is an anonim or not

firstNamestring

First name

lastNamestring

Last name

userNamestring

Username

emailstringformat: email

contactsarray of object

List of contacts

typestring: Contact type
valuestring: Contact value

birthdayobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

sexstring

Sex

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: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

departmentstring

Department

workFromobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

groupsarray of object

List of groups

idstringformat: uuid: ID
namestring: Name
managerstring: Manager

locationstring

Location

notesstring

Notes

isAdminboolean

Specifies if the user is an administrator or not

isRoomAdminboolean

Specifies if the user is a room administrator or not

isLDAPboolean

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

listAdminModulesarray of string

List of administrator modules

isOwnerboolean

Specifies if the user is a portal owner or not

isVisitorboolean

Specifies if the user is a portal visitor or not

isCollaboratorboolean

Specifies if the user is a portal collaborator or not

cultureNamestring

Language

mobilePhonestring

Mobile phone number

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

Specifies if the SSO settings are enabled for the user or not

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

Quota limit

usedSpacenumberformat: double

Portal used space

sharedboolean

Shared

isCustomQuotaboolean

Specifies if the user has a custom quota or not

loginEventIdintegerformat: int32

Current login event ID

createdByobject

idstringformat: uuid: ID
displayNamestring: Display name
titlestring: Title
avatarstring: Avatar
avatarOriginalstring: Original size avatar
avatarMaxstring: Maximum size avatar
avatarMediumstring: Medium size avatar
avatarSmallstring: Small avatar
profileUrlstring: Profile URL
hasAvatarboolean: Specifies if the user has an avatar or not
isAnonimboolean: Specifies if the user is an anonim or not

registrationDateobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

sharedboolean

Shared

membersCountintegerformat: int32

Members count

401

Unauthorized

404

Group not found

Get Help

If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
You can request a feature or report a bug by posting an issue on GitHub.
You can also ask our developers on ONLYOFFICE forum (registration required).

Get a group

Request

Authorization

Headers

Path

Query

Examples

Responses

200

401

404

Results

Get Help