Get Opportunity Lists
This API returns the Opportunity Lists available in your account. Use it to build a list picker, display member counts, or check which lists exist for a given Opportunity Type.
You can filter the results by list type (Static or Dynamic) or by searching for a list name, and sort the results by fields like name, member count, or creation date.
Note: All request fields are optional, but you must send a request body – An empty JSON object (
{}).API URL
URL
POST
https://{host}/v2/OpportunityManagement.svc/Lists/Opportunities/Retrieve?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/json
JSON Body/Payload
{
"ListType": 0,
"SearchText": "Chennai",
"SortColumn": "MemberCount",
"SortOrder": 1,
"Columns": "ListId,Name,MemberCount,ListType,CreatedOn",
"Paging": {
"PageIndex": 1,
"PageSize": 50
}
}
Request Parameters
| Parameter | Description |
|---|---|
| ListType | Filter by list type:
Omit to return all. |
| SearchText | Find lists whose name contains a specific keyword (case-sensitive). |
| SortColumn | Control how the fields are sorted. Allowed:
The default value is |
| SortOrder | Control how the results are sorted.
The default value is |
| Columns | Choose which list details are returned. Default columns (if Columns is omitted): |
| Paging | Control how many results are returned per page. Max page size is 1000. |
Response
200 OK
Content-Type: application/json
{
"Lists": [
{
"ListId": "ccbba9d8-90e1-468d-90bc-bc5e4a6248d9",
"Name": "Chennai Opportunities",
"MemberCount": 8,
"ListType": 0,
"CreatedOn": "/Date(1786434435000+0000)/"
}
],
"TotalCount": 1
}
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. |
