PBX API : GET /Contacts/:id/

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

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

GET Parameters

Required Parameters

NameDescription

Optional Parameters:

NameDefaultPossible valuesDescription

fields

All

id
name
email
extension
phone
office
home
home_mobile
fax
mobile
organization
picture
shortcut
phonebook_id
type
note
address
vat_id
name_prefix
document_type
document_id
pin
credit
hash
country
date_birth
born_in
postal_code
city
province
license_plate
document_released
document_from
last_update

A list of fields that should be returned

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

Example:

GET http://{PBX}/api/v1/Contacts/8159/
 {
    "type":"result",
    "result":{
        "id":8159,
        "name":"user2",
        "email":"email@gmail.com",
        "extension":"345",
        "phone":"",
        "office":"",
        "home":"",
        "home_mobile":"",
        "fax":"",
        "mobile":"+391234567890",
        "organization":"LDAP",
        "picture":"",
        "shortcut":"",
        "phonebook_id":2,
        "type":"",
        "note":"",
        "address":"",
        "vat_id":"",
        "name_prefix":"",
        "document_type":"",
        "document_id":"",
        "pin":"",
        "credit":"",
        "hash":"60e7e366c7a3af65258e7a3542d82d51",
        "country":"",
        "date_birth":"",
        "born_in":"",
        "postal_code":"",
        "city":"",
        "province":"",
        "license_plate":"",
        "document_released":"",
        "document_from":"",
        "last_update":"2013-06-07 11:50:02"
    }
}