Get an Account
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Lets you retrieve the details of one or more accounts (companies). You must specify the “CompanyTypeName” in the JSON body.
API URL
URL
POST
https://{host}/v2/CompanyManagement.svc/Company.Get?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"Query": {
"CompanyType": {"CompanyTypeName": "Partners"},
"SearchText": "Partner",
"DateRange": {"DateField": "ModifiedOn","FromDate": "2018-09-23 18:30:00","ToDate": "2018-09-24 18:29:59"},
"FilterBy": {"LookupName": "Stage","LookupValue": "Partner","SqlOperator": "="}
},
"Columns": {"Include_CSV": "CompanyId,CompanyName,Phone,Website"},
"Sorting": {"ColumnName": "ModifiedOn","Direction": "1"},
"Paging": {"PageIndex": 1,"PageSize": 100}
}
Request Parameters
| Parameter | Description |
|---|---|
| CompanyType | Specify the CompanyTypeName under which you want to retrieve the details of one or more companies. This parameter is mandatory. |
| SearchText | You can enter the name of the company here. |
| DateRange | If you want to retrieve companies based on a date range, specify –
|
| FilterBy | Lets you narrow down your search criteria based on a parameter.
|
Response
200 OK
Content-Type: application/json
{
"RecordCount": 2,
"Companies": [
{
"companyPropertyList": [
{
"Attribute": "CompanyId",
"Value": "b35334e6-24a2-466c-a3ae-200bcafa680e"
},
{
"Attribute": "CompanyName",
"Value": "Partner Name"
},
{
"Attribute": "Phone",
"Value": "+91-8923748971"
},
{
"Attribute": "Website",
"Value": "www.partner.com"
}
]
},
{
"companyPropertyList": [
{
"Attribute": "CompanyId",
"Value": "82a19544-ef4f-4cef-a09c-d68b939742f9"
},
{
"Attribute": "CompanyName",
"Value": "Partner1"
},
{
"Attribute": "Phone",
"Value": "+91-8928391232"
},
{
"Attribute": "Website",
"Value": "www.example.com"
}
]
}
]
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
