Queries contacts.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ContactId | string | No | The ID of the contact. | c-qL4HqKONzOM7**** |
Member | string | No | The ID of the object to which the contact is bound. Valid values:
| fd-ZDNPiT**** |
PageNumber | integer | No | The page number. | 1 |
PageSize | integer | No | The number of entries per page. | 10 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "95060F1D-6990-4645-8920-A81D1BBFE992",
"TotalCount": 20,
"PageSize": 10,
"PageNumber": 1,
"Contacts": [
{
"ContactId": "c-qL4HqKONzOM7****",
"Name": "tom",
"EmailAddress": "someone***@example.com",
"PhoneNumber": "86-139****1234",
"Title": "TechnicalDirector",
"MessageTypes": [
"AccountExpenses"
],
"Members": [
"fd-ZDNPiT****"
],
"Status": "Active",
"CreateDate": "2023-03-27 17:19:21",
"AssociatedDate": "2023-03-27 17:19:21"
}
]
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParameter.ContactId | The ContactId is invalid. | The value of the ContactId parameter is invalid. |
400 | InvalidParameter.Member | The Member is invalid. | The value of the Member parameter is invalid. |
404 | EntityNotExists.Contact | This Contact does not exist. | The specified contact does not exist. |
404 | EntityNotExists.Member | This Member does not exist. | The specified member does not exist. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|
No change history