Query a Specific Customer

HTTP method and endpoint

GET /api/v1/system/customers/{customer_id}

Request parameters


Parameter	Importance	Type	Description
customer_id	Required	Integer	Customer ID.

Response parameters


Parameter	Type	Description
customer	Object	Customer information.
id	Integer	Customer ID.
company	String	Company name.
contactName	String	Contact name.
email	String	Email address.
position	String	Job title.
cellphone	String	Cell phone number.
telephone	String	Telephone number.
fax	String	Fax number.
address	String	Company address.
remark	String	Remark.
externalId	String	External ID.

Examples

Request example

GET /api/v1/system/customers/2 HTTP/1.1
Host: ympapi.yeastarcloud.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9uYW1lIjoiY2VjaWxpYUB5ZWFzdGFyLmNvbSIsInNjb3BlIjpbInRydXN0Il0sImV4cCI6MTU0NjkzNTg1OCwiYXV0aG9yaXRpZXMiOlsiUk9MRV9hZG1pbiJdLCJqdGkiOiJlNzJkMjNlYi03NjdhLTRhZmItYjQ2Zi03YzYxNmJmN2EzYjgiLCJjbGllbnRfaWQiOiI5Nzg5OTNmMDk2YzQ0MTFmYTljYzgwZWUyZTYyZjFmMiJ9.1HyxxEGbGNDc9A4ihm-dXGoKRhFh_YKYeOrNgt1IhRc
Cache-Control: no-cache

Response example

HTTP/1.1 200 OK
{
    "status": "Success",
    "customer": {
        "address": "",
        "cellphone": "",
        "company": "cyt",
        "contactName": "cyt",
        "email": "cecilia@yeastar.com",
        "fax": "",
        "id": 2,
        "position": "",
        "remark": "",
        "telephone": ""
    }
}