Query Company Contacts List

Query the company contacts list.

Request URL

GET {base_url}/{api_path}/company_contact/list?access_token={access_token}

Request parameters

Table 1.
Parameter Required Type Description
page No Integer Define which page is displayed.
Note: If this parameter is left blank, the response result will return the first page by default.
page_size No Integer Define how many records per page.

Maximum value: 10,000

Note: If this parameter is left blank, the response result will return 10,000 records per page by default.
sort_by No String Define the sorting field.

Valid value:

  • id
  • contact_name
  • company
  • email
  • business
  • mobile
  • home
  • business_fax
order_by No String Define the display order.

Valid value:

  • asc: Ascending order.
  • desc: Descending order.

Response parameters

Table 2.
Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
total_number Integer The total number of company contacts.
data Array<Contact_Info> The list of the company contacts' information.
Contact_Info
Table 3.
Parameter Type Description
id Integer Company contact ID.
contact_name String Company contact name.
company String Company.
email String Email address.
phonebook_list Array<Phonebook_List> The list of phonebook to which the company contact belongs.
remark String Remark.
business String Business number.
business2 String Business number 2.
mobile String Mobile number.
mobile2 String Mobile number 2.
home String Home number.
home2 String Home number 2.
business_fax String Business fax.
home_fax String Home fax.
other String Other number.
Phonebook_List
Table 4.
Parameter Type Description
id Integer Phonebook ID.
name String Phonebook name.

Examples

Request example

GET /openapi/v1.0/company_contact/list?access_token=DcOjrsEXYM1v2KRkcGvE2RO5n8exvuOe HTTP/1.1  

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 3,
    "data": [
        {
            "id": 3,
            "contact_name": "Joseph Goffin",
            "company": "Ticketsales",
            "email": "joseph@gmail.com",
            "business": "12354978652",
            "phonebook_list": [
                {
                    "id": 5,
                    "name": "Vendor"
                },
                {
                    "id": 3,
                    "name": "All Company Contacts_Phonebook"
                }
            ]
        },
        {
            "id": 4,
            "contact_name": "Jay Prichett",
            "company": "Closet",
            "email": "jayprichett@icloud.com",
            "business": "001-5503308",
            "mobile": "15735810000",
            "phonebook_list": [
                {
                    "id": 5,
                    "name": "Vendor"
                },
                {
                    "id": 3,
                    "name": "All Company Contacts_Phonebook"
                }
            ]
        },
        {
            "id": 5,
            "contact_name": "Phill  Dunphy",
            "company": "Modern",
            "email": "philclaire@icloud.com",
            "business": "846321645",
            "phonebook_list": [
                {
                    "id": 3,
                    "name": "All Company Contacts_Phonebook"
                }
            ]
        }
    ]
}