PBX API : GET /Colleagues/:id/

To get a colleagues, make an HTTP GET request with basic authorization, resource URI:

http(s)://{PBX}/api/v1/Colleagues/:id/

GET Parameters

Required Parameters

NameDescription

Optional Parameters:

NameDefaultPossible valuesDescription

fields

All

dn
id
name
extension
officePhone
mobilePhone
faxNumber
email
pbxDn
role
groupDn
language
dialplan
faxDialplan
department

A list of fields that should be returned

Maybe using with comma "," for listing all required fields

sync_params - only for admins

Example:

GET http://{PBX}/api/v1/Colleagues/2951881/
 {
    "type":"result",
    "result":{
        "dn":"uid=2951881,o=com0,dc=wildix",
        "id":"2951881",
        "name":"Gift Frolund",
        "extension":"27973",
        "officePhone":"",
        "mobilePhone":"+38093527973",
        "faxNumber":"+38063527973",
        "email":"gift_frolund@example.com",
        "pbxDn":"pbxid=000c29044037,dc=wildix",
        "role":"user",
        "groupDn":"gid=14082460,o=com0,dc=wildix",
        "language":"en",
        "dialplan":"users",
        "faxDialplan":"users",
        "department":"Blood Raven"
    }
}