Members

List user group members

Retrieve a collection of user group members.

get

/groups/{id}/members

Authorizations

Path parameters

idall ofrequired

The unique ID of user group.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/groups/{id}/members' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

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

OK

Check user group member

Check if extension is in user group.

get

/groups/{id}/members/{extension_number}

Authorizations

Path parameters

idall ofrequired

The unique ID of user group.

extension_numberstring · min: 3 · max: 64required

The extension number.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/groups/{id}/members/{extension_number}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

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

OK

Add user group member

Add user member into group.

post

/groups/{id}/members/{extension_number}

Authorizations

Path parameters

idall ofrequired

The unique ID of user group.

extension_numberstring · min: 3 · max: 64required

The extension number.

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

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/groups/{id}/members/{extension_number}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

No body

OK