GET/contact

Function


The GET/contact method returns a list of personal contacts for a user based on the provided basic authorization credentials. 


The response has the following fields of information:


  • ID- the unique ID of the contact. 
  • fname -  the first name of the contact. 
  • lname - the last name of the contact. 
  • organization - the organization (company) of the contact. 
  • email - the email of the contact. 
  • number - the phone number (landline) of the contact.
  • mobile - the mobile phone number of the contact. 
  • fax - the fax number of the contact.
  • website - the website of the contact.
  • image - if an image of the contact has been uploaded by the user,  a path to the image will be detailed in this field.
  • public - a value of 1 indicates the contact is public. A public contact is made available to other users in the company on their own list of contacts.
  • owned - A value of 1 indicates the contact is owned by the user, that is it has been created and can be edited by him.


Parameters


All parameters go in the header.


Parameter
Type
Operation
contact_id
string
You can specify a specific contact ID to be returned. Only the record for this contact will be included in t he response. Several IDs can be specified with separate parameters.
limit
integer
Specify the number of records to be returned by the request.
offset
Integer
Specify the first record to display. For example an offset of 3 will start the list on the 3rd record. If left empty the default will be the first record.


Example


To get the a list of personal contacts use this syntax:


webserv.telebroad.com/api/teleconsole/rest/contact?limit=2


HTTP method: GET


Response:


{

    "error":null,

        "result":

        [{"id":"1592",

            "fname":"Nick",

            "lname":"Ramon",

            "organization":"GNV Consulting",

            "email":"N.ramon@gnvc.com",

            "number":"201-711-2400",

            "mobile":"201-483-5171",

            "fax":"201-711-2401",

            "website":"//gnvc.com",

            "image":

            https:\/\/telebroad.com\/cdn\

            /avatar\/0f\/da\/c5c5ecf77f32ca541003

            b32e8b2d02hfa301.png",

            "public":"0",

            "owned":1},

        {"id":"6942",

            "fname":"Andy",

            "lname":"Klein",

            "organization":"",

            "email":"andy.klein28@gmail.com",

            "number":"917-838-4128",

            "mobile":"917-383-42128",

            "fax":"",

            "website":"",

            "image":"",

            "public":"0",

            "owned":1}

        ]

}

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.