younifyd
Menu

Post /crm/v3/associations/{from Object Type}/{to Object Type}/batch/read Read

Retrieve associations

POST/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/read

Use it in a workflow

  1. Add a step and choose the HubSpot connector.
  2. Pick the Post /crm/v3/associations/{from Object Type}/{to Object Type}/batch/read Read action (under Associations).
  3. Fill in the fields below, then reference the result from later steps as {{postCrmV3AssociationsFromObjectTypeToObjectTypeBatchReadRead.response.data}}.

Request

Path parameters

fromObjectTypestringrequired
toObjectTypestringrequired

Request body

Enter the body as JSON in the step's Body field.

inputsarray<object>required
idstringrequired

ID of the object

json
{
  "inputs": [
    {
      "id": "37295"
    }
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{postCrmV3AssociationsFromObjectTypeToObjectTypeBatchReadRead.response.data.<field>}}.

completedAtstring (date-time)
linksobject
requestedAtstring (date-time)
resultsarray<object>
fromobjectrequired1 fields

Contains the Id of a Public Object

pagingobject2 fields
toarray<object>required2 fields

The IDs of objects that are associated with the object identified by the ID in 'from'.

startedAtstring (date-time)
statusstring

One ofCANCELEDCOMPLETEPENDINGPROCESSING

json
{
  "completedAt": "2025-01-01T00:00:00Z",
  "results": [
    {
      "from": {
        "id": "53628"
      },
      "to": [
        {
          "id": "12726",
          "type": "contact_to_company"
        },
        {
          "id": "61352",
          "type": "contact_to_company"
        }
      ]
    }
  ],
  "startedAt": "2025-01-01T00:00:00Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2025-01-01T00:00:00Z"
}

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.