Get User Group


This request returns the information of a user group, including its associated users and phone lines.

Resource

GET /usergroups/<OID>

Where OID is the object ID of the user group.

Parameters

None

Payload

None

Context

Authorization

Admin

Errors

Example

Request
GET https://xelion.nl/api/v1/master/usergroups/2407745
Response
{
    "object": {
        "users": [
            {
                "user": {
                    "person": {
                        "permissions": "ReadWriteRemove",
                        "commonName": "Sithtrooper I",
                        "oid": "2358921",
                        "objectType": "Person"
                    },
                    "commonName": "sit1",
                    "oid": "2358934",
                    "objectType": "UserProfile"
                },
                "oid": "2407747",
                "objectType": "XCCUserGroupParticipant"
            },
            {
                "user": {
                    "person": {
                        "permissions": "ReadWriteRemove",
                        "commonName": "Sithtrooper II",
                        "oid": "2359069",
                        "objectType": "Person"
                    },
                    "commonName": "sit2",
                    "oid": "2359082",
                    "objectType": "UserProfile"
                },
                "oid": "2407749",
                "objectType": "XCCUserGroupParticipant"
            },
            {
                "user": {
                    "person": {
                        "permissions": "ReadWriteRemove",
                        "commonName": "Sithtrooper III",
                        "oid": "2359217",
                        "objectType": "Person"
                    },
                    "commonName": "sit3",
                    "oid": "2359255",
                    "objectType": "UserProfile"
                },
                "oid": "2407750",
                "objectType": "XCCUserGroupParticipant"
            },
            {
                "user": {
                    "person": {
                        "permissions": "ReadWriteRemove",
                        "commonName": "Sithtrooper IV",
                        "oid": "2359390",
                        "objectType": "Person"
                    },
                    "commonName": "sit4",
                    "oid": "2359403",
                    "objectType": "UserProfile"
                },
                "oid": "2407751",
                "objectType": "XCCUserGroupParticipant"
            }
        ],
        "lines": [
            {
                "line": {
                    "commonName": "Stormtroopers",
                    "oid": "2407649",
                    "objectType": "XCCPhoneLine"
                },
                "skillNumber": 0,
                "incoming": true,
                "outgoing": false,
                "editable": "INCOMINGANDOUTGOING",
                "oid": "2409122",
                "objectType": "XCCConnectedUserGroup"
            }
        ],
        "permissions": "ReadWriteRemove",
        "commonName": "Sithtroopers",
        "oid": "2407745",
        "objectType": "XCCUserGroup"
    },
    "links": [
        {
            "rel": "self",
            "method": "GET"
        }
    ]
}