Get Associations Linked to an Object Type
Retrieves all the Associations linked with an Object Type.
API URL
URL
POST
https://{host}/v2/LeadTypes.svc/LeadTypeAssociation/Retrieve?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/json
JSON Body/Payload
{
"LeadTypeAssociation": {
"ParentLeadId": [
"79e04544-5e48-4328-8e2c-767f9cda4e17"
],
"ParentLeadType": "OT_0",
"AssociationFieldSchemaName": "LeadTypeAssociation_OT_0_OT_1"
},
"Paging": {
"PageIndex": 1,
"PageSize": 10
}
}
Request Parameters
| Parameter | Description |
|---|---|
| ParentLeadId | Pass the Lead Id for the Parent Object Type. To obtain this, refer to the Get Lead by Email API or Get Lead by Phone API. The |
| ParentLeadType | Pass the Internal Name for the Parent Object Type.
|
| AssociationFieldSchemaName | Pass the schema name of the Parent Object Type’s Associated Field Name. To get this value, call Get Object Types Associations and use the
|
| PageIndex | Pass 1 |
| PageSize | Pass the page size. |
Response
200 OK
Content-Type: application/json
{
"RecordCount": 4,
"Leads": [
{
"LeadPropertyList": [
{
"Attribute": "ProspectID",
"Value": "06b89148-17b1-4c5a-9c45-af3cfef8652a",
"Fields": null
},
{
"Attribute": "ProspectAutoId",
"Value": "79396",
"Fields": null
},
{
"Attribute": "EmailAddress",
"Value": null,
"Fields": null
},
{
"Attribute": "mx_Street1",
"Value": null,
"Fields": null
},
{
"Attribute": "mx_City",
"Value": null,
"Fields": null
},
{
"Attribute": "CanUpdate",
"Value": "true",
"Fields": null
}
]
},
{
"LeadPropertyList": [
{
"Attribute": "ProspectID",
"Value": "46efe0e0-326f-4557-988a-da9bb3136194",
"Fields": null
},
{
"Attribute": "ProspectAutoId",
"Value": "79397",
"Fields": null
},
{
"Attribute": "EmailAddress",
"Value": null,
"Fields": null
},
{
"Attribute": "mx_Street1",
"Value": null,
"Fields": null
},
{
"Attribute": "mx_City",
"Value": null,
"Fields": null
},
{
"Attribute": "CanUpdate",
"Value": "true",
"Fields": null
}
]
},
{
"LeadPropertyList": [
{
"Attribute": "ProspectID",
"Value": "c75c0c61-a7c9-4525-af2e-a42a4f65db18",
"Fields": null
},
{
"Attribute": "ProspectAutoId",
"Value": "79398",
"Fields": null
},
{
"Attribute": "EmailAddress",
"Value": null,
"Fields": null
},
{
"Attribute": "mx_Street1",
"Value": null,
"Fields": null
},
{
"Attribute": "mx_City",
"Value": null,
"Fields": null
},
{
"Attribute": "CanUpdate",
"Value": "true",
"Fields": null
}
]
},
{
"LeadPropertyList": [
{
"Attribute": "ProspectID",
"Value": "fa801dd5-925b-44b4-9f27-a00ff7d0fca4",
"Fields": null
},
{
"Attribute": "ProspectAutoId",
"Value": "79399",
"Fields": null
},
{
"Attribute": "EmailAddress",
"Value": null,
"Fields": null
},
{
"Attribute": "mx_Street1",
"Value": null,
"Fields": null
},
{
"Attribute": "mx_City",
"Value": null,
"Fields": null
},
{
"Attribute": "CanUpdate",
"Value": "true",
"Fields": 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. |
