Get a Custom Action
This downloads our complete API collection, including all endpoints—not just
this specific endpoint.
Returns the details of an existing custom action based on the “ConnectorId” and “ActionType”.
API URL
URL
GET
https://{host}/v2/Connector.svc/CustomAction/Retrieve?accessKey=AccessKey&secretKey=SecretKey&connectorId=ConnectorId&actionType=ActionType
URL Parameters
| Parameter | Description |
|---|---|
| ConnectorId | This is the unique ID of the connector. Please contact support@leadsquared.com in order to get this |
| ActionType | The action type of the custom action. |
Response
200 OK
Content-Type: application/json
{
"ManageListsRowAction":[
{
"Id":"bfa541e4-8f98-4f1e-93f8-4bad2dc6cab3",
"Category":"Custom Actions",
"Config":{
"Action":"OpenNewWindow",
"ActionConfig":{
"ContentType":"application/json",
"Data":"",
"Method":"POST",
"URL":"https://run.lsq-staging.com/Settings/ManageUsers"
},
"DisplayText":"1",
"IsEnabled":true,
"RestrictedRoles":"Sales_User"
}
},
{
"Id":"83ddba6d-17c9-414a-b1e4-876662836793",
"Category":"Custom Actions",
"Config":{
"Action":"OpenNewWindow",
"ActionConfig":{
"ContentType":"application/json",
"Data":"",
"Method":"POST",
"URL":"https://run.lsq-staging.com/Settings/UserAccessKey"
},
"DisplayText":"2",
"IsEnabled":true,
"RestrictedRoles":"Sales_User"
}
}
]
}
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. |
