Members

List user group members

get

Retrieve a collection of user group members.

Authorizations
Path parameters
idall ofRequired

The unique ID of user group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/groups/{id}/members HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "display_name": "text",
      "extension_number": "text"
    }
  ]
}

Check user group member

get

Check if extension is in user group.

Authorizations
Path parameters
idall ofRequired

The unique ID of user group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
extension_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}
Responses
200
OK
application/json
get
GET /api/groups/{id}/members/{extension_number} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "display_name": "text",
  "extension_number": "text"
}

Add user group member

post

Add user member into group.

Authorizations
Path parameters
idall ofRequired

The unique ID of user group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
extension_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}
Responses
200
OK
post
POST /api/groups/{id}/members/{extension_number} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content