GET
/
crm-associations
/
v1
/
associations
/
{objectId}
/
HUBSPOT_DEFINED
/
{definitionId}
Get associations for a CRM object
curl --request GET \
  --url https://api.hubapi.com/crm-associations/v1/associations/{objectId}/HUBSPOT_DEFINED/{definitionId}
"\nExample GET URL, pulling the IDs for tickets associated with a contact with vid 25:\nhttps://api.hubapi.com/crm-associations/v1/associations/25/HUBSPOT_DEFINED/15\n\nExample response with two associated tickets:\n{\n  \"results\": [\n    259674,\n    259727\n  ],\n  \"hasMore\": false,\n  \"offset\": 259727\n}\n\nExample GET URL, pulling the IDs for companies associated with a ticket with id 259674:\nhttps://api.hubapi.com/crm-associations/v1/associations/7106518/HUBSPOT_DEFINED/26?hapikey=demo\n\nExample response with one associated company:\n{\n  \"results\": [\n    184896670\n  ],\n  \"hasMore\": false,\n  \"offset\": 184896670\n}"

Path Parameters

objectId
string
required

The ID of the object that you want to get the associations for.

definitionId
string
required

The ID of the type of associations you want. See the table on the overview page for a list of these IDs.

Query Parameters

limit
string

The number of associations to return in a single response. Defaults to 10 if the parameter is not included, supports a maximum value of 100.

offset
string

Used to page through the results. Each response will include an offset, which can be used to get the next set of results in the next request.

Response

200 - application/json

Successful response - Use this endpoint to get the IDs of CRM objects associated with a given object, based on the specified association type

The response is of type object.