Retrieves a list of companies.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| CurrentPage |
integer |
No |
The page number of the current page. Default value: 1. |
1 |
| ShowSize |
integer |
No |
The number of contacts to display per page in a paged query. |
20 |
| Keyword |
string |
No |
The search keyword. For example, a keyword for the company name, province, country code, or city. |
test |
| CompanyId |
integer |
No |
The company ID. |
51001 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| CurrentPage |
integer |
Settings the page number of the current page in a paged query for paging. Default value: 1. |
1 |
| RequestId |
string |
The request ID. |
285BBE08-F12B-5A04-97BC-09EA7FF18646 |
| TotalCount |
integer |
The total number of search results. |
2 |
| ShowSize |
integer |
The number of certificates to display per page in a paged query. Default value: 10. |
10 |
| CompanyList |
array<object> |
The list of companies. |
|
|
object |
The company object. |
||
| PostCode |
string |
The postal code. |
100000 |
| CompanyType |
integer |
The company code. |
xxx |
| City |
string |
The city. |
Beijing |
| CompanyId |
integer |
The company ID. |
51001 |
| CompanyPhone |
string |
The company phone number. |
1511 |
| CompanyCode |
string |
The company code. |
xxx |
| CompanyAddress |
string |
The company address. |
test |
| CountryCode |
string |
The country code. |
CN |
| CompanyEmail |
string |
The company email address. |
test@163.com |
| CompanyName |
string |
The name of the company or organization. |
testYanwen045 |
| Province |
string |
The province. |
test |
| Department |
string |
The department. |
test |
| Lang |
string |
The language. |
zh |
Examples
Success response
JSON format
{
"CurrentPage": 1,
"RequestId": "285BBE08-F12B-5A04-97BC-09EA7FF18646",
"TotalCount": 2,
"ShowSize": 10,
"CompanyList": [
{
"PostCode": "100000",
"CompanyType": 0,
"City": "Beijing",
"CompanyId": 51001,
"CompanyPhone": "1511",
"CompanyCode": "xxx",
"CompanyAddress": "test",
"CountryCode": "CN",
"CompanyEmail": "test@163.com",
"CompanyName": "testYanwen045",
"Province": "test",
"Department": "test",
"Lang": "zh"
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.