Members

List user group members

Retrieve a collection of user group members.

GEThttp://127.0.0.1:8888/api/groups/{id}/members

Path parameters

id*all of

The unique ID of user group.

Response

2004XX

OK

Body

application/json

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/groups/{id}/members', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": {},
      "name": "text",
      "display_name": "text",
      "extension_number": "text"
    }
  ]
}

Check user group member

Check if extension is in user group.

GEThttp://127.0.0.1:8888/api/groups/{id}/members/{extension_number}

Path parameters

id*all of

The unique ID of user group.

extension_number*string

The extension number.

Pattern: [0-9]{3,64}

Response

200404

OK

Body

application/json

idall of

The unique ID of user.

namestring

The user's account name.
Only letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .).
Username cannot start or end with period (.).
admin, system, administrator, and root are reserved names for system admin only with case ignored.

display_namestring

The display name of user.

extension_numberstring

The extension number.

Pattern: [0-9]{3,64}

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/groups/{id}/members/{extension_number}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "name": "text",
  "display_name": "text",
  "extension_number": "text"
}

Add user group member

Add user member into group.

POSThttp://127.0.0.1:8888/api/groups/{id}/members/{extension_number}

Path parameters

id*all of

The unique ID of user group.

extension_number*string

The extension number.

Pattern: [0-9]{3,64}

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/groups/{id}/members/{extension_number}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();