Retrieve a Custom Opportunity Tab
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Returns the details of a custom tab for the Custom Opportunity Tab Connector. You need to pass the ConnectorId in the API URL.
API URL
URL
GET
https://{host}/v2/Connector.svc/Opportunity/CustomTab/Retrieve?accessKey=AccessKey&secretKey=SecretKey&connectorId=ConnectorId&entityType=EntityType
URL Parameters
| Parameter | Description |
|---|---|
| ConnectorId | Please contact support@leadsquared.com in order to get this |
| EntityType | The Opportunity Entity Type Code. You can find this on the Opportunity Types Setting page on your LeadSquared Dashboard. |
Response
200 OK
Content-Type: application/json
[
{
"EntityType": "12000",
"Id": "6c2daef1-5f9a-4940-8613-c5ac8a04444444",
"Type": 0,
"Consumer": null,
"RestrictedRoles": [
"SalesUser"
],
"IsEnabled": true,
"ShowInWeb": true,
"ShowInMobile": true,
"TabConfiguration": {
"Title": "Test744",
"Position": 2,
"Location": null,
"TabPosition": 0,
"Sequence": 0,
"IsDefault": false,
"ShowInForm": false
},
"TabContentConfiguration": {
"Title": "Test744",
"URL": "https://forms.office.com/Pages/ResponsePage.aspx?id=YsdjOZS3lkyQUPR9nal2OO6QtoQoa9tLs6T5EkzgYOFUOTBEWUZKTkFSOTRQU0MwV0JPVDNIRDU55555",
"Height": null,
"Width": null,
"Activities": null,
"From": null,
"To": null,
"OnClick": null,
"CanEdit": false,
"CanDelete": false,
"IsHidden": false,
"CanClone": false,
"CanHide": false,
"OptFilter": null,
"LeadFilter": null
},
"LastUpdatedOn": null,
"AdvanceFilter": null
},
{
"EntityType": "12000",
"Id": "732d2168-bc94-493d-b5a0-fe662ce6b040",
"Type": 0,
"Consumer": null,
"RestrictedRoles": [
"SalesUser"
],
"IsEnabled": true,
"ShowInWeb": true,
"ShowInMobile": true,
"TabConfiguration": {
"Title": "Test304",
"Position": 2,
"Location": null,
"TabPosition": 0,
"Sequence": 0,
"IsDefault": false,
"ShowInForm": false
},
"TabContentConfiguration": {
"Title": "Test304",
"URL": "https://forms.office.com/Pages/ResponsePage.aspx?id=YsdjOZS3lkyQUPR9nal2OO6QtoQoa9tLs6T5EkzgYOFUOTBEWUZKTkFSOTRQU0MwV0JPVDNIRDU55555",
"Height": null,
"Width": null,
"Activities": null,
"From": null,
"To": null,
"OnClick": null,
"CanEdit": false,
"CanDelete": false,
"IsHidden": false,
"CanClone": false,
"CanHide": false,
"OptFilter": null,
"LeadFilter": null
},
"LastUpdatedOn": null,
"AdvanceFilter": null
},
{
"EntityType": "12000",
"Id": "ebefe537-9274-4e0b-aa49-d750f2349506",
"Type": 0,
"Consumer": null,
"RestrictedRoles": [
"SalesUser"
],
"IsEnabled": true,
"ShowInWeb": true,
"ShowInMobile": true,
"TabConfiguration": {
"Title": "Test783",
"Position": 2,
"Location": null,
"TabPosition": 0,
"Sequence": 0,
"IsDefault": false,
"ShowInForm": false
},
"TabContentConfiguration": {
"Title": "Test783",
"URL": "https://forms.office.com/Pages/ResponsePage.aspx?id=YsdjOZS3lkyQUPR9nal2OO6QtoQoa9tLs6T5EkzgYOFUOTBEWUZKTkFSOTRQU0MwV0JPVDNIRDU55555",
"Height": null,
"Width": null,
"Activities": null,
"From": null,
"To": null,
"OnClick": null,
"CanEdit": false,
"CanDelete": false,
"IsHidden": false,
"CanClone": false,
"CanHide": false,
"OptFilter": null,
"LeadFilter": null
},
"LastUpdatedOn": null,
"AdvanceFilter": null
},
{
"EntityType": "12000",
"Id": "f0d8ee0f-bbe2-4a10-95d8-d3406e67332e",
"Type": 0,
"Consumer": null,
"RestrictedRoles": [
"SalesUser"
],
"IsEnabled": true,
"ShowInWeb": true,
"ShowInMobile": true,
"TabConfiguration": {
"Title": "Test3",
"Position": 2,
"Location": null,
"TabPosition": 0,
"Sequence": 0,
"IsDefault": false,
"ShowInForm": false
},
"TabContentConfiguration": {
"Title": "Test3",
"URL": "https://forms.office.com/Pages/ResponsePage.aspx?id=YsdjOZS3lkyQUPR9nal2OO6QtoQoa9tLs6T5EkzgYOFUOTBEWUZKTkFSOTRQU0MwV0JPVDNIRD55555",
"Height": null,
"Width": null,
"Activities": null,
"From": null,
"To": null,
"OnClick": null,
"CanEdit": false,
"CanDelete": false,
"IsHidden": false,
"CanClone": false,
"CanHide": false,
"OptFilter": null,
"LeadFilter": null
},
"LastUpdatedOn": null,
"AdvanceFilter": null
},
{
"EntityType": "12000",
"Id": "cf21e9a5-b4ec-460c-b512-f88d71e42db4",
"Type": 0,
"Consumer": null,
"RestrictedRoles": [
"SalesUser"
],
"IsEnabled": true,
"ShowInWeb": true,
"ShowInMobile": true,
"TabConfiguration": {
"Title": "Test382",
"Position": 2,
"Location": null,
"TabPosition": 0,
"Sequence": 0,
"IsDefault": false,
"ShowInForm": false
},
"TabContentConfiguration": {
"Title": "Test382",
"URL": "https://forms.office.com/Pages/ResponsePage.aspx?id=YsdjOZS3lkyQUPR9nal2OO6QtoQoa9tLs6T5EkzgYOFUOTBEWUZKTkFSOTRQU0MwV0JPVDNIRDU55555",
"Height": null,
"Width": null,
"Activities": null,
"From": null,
"To": null,
"OnClick": null,
"CanEdit": false,
"CanDelete": false,
"IsHidden": false,
"CanClone": false,
"CanHide": false,
"OptFilter": null,
"LeadFilter": null
},
"LastUpdatedOn": null,
"AdvanceFilter": null
},
{
"EntityType": "12000",
"Id": "5f6e14a9-aa43-4856-b93a-5eae4fcf6644",
"Type": 0,
"Consumer": null,
"RestrictedRoles": [
"SalesUser"
],
"IsEnabled": true,
"ShowInWeb": true,
"ShowInMobile": true,
"TabConfiguration": {
"Title": "Test383",
"Position": 2,
"Location": null,
"TabPosition": 0,
"Sequence": 0,
"IsDefault": false,
"ShowInForm": false
},
"TabContentConfiguration": {
"Title": "Test383",
"URL": "https://forms.office.com/Pages/ResponsePage.aspx?id=YsdjOZS3lkyQUPR9nal2OO6QtoQoa9tLs6T5EkzgYOFUOTBEWUZKTkFSOTRQU0MwV0JPVDNIRDU55555",
"Height": null,
"Width": null,
"Activities": null,
"From": null,
"To": null,
"OnClick": null,
"CanEdit": false,
"CanDelete": false,
"IsHidden": false,
"CanClone": false,
"CanHide": false,
"OptFilter": null,
"LeadFilter": null
},
"LastUpdatedOn": null,
"AdvanceFilter": null
}
]
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. |
