Get /crm/v3/objects/contacts Get Page

Retrieve contacts

GET/crm/v3/objects/contacts

Use it in a workflow

Add a step and choose the HubSpot connector.
Pick the Get /crm/v3/objects/contacts Get Page action (under Contacts).
Fill in the fields below, then reference the result from later steps as {{getCrmV3ObjectsContactsGetPage.response.data}}.

Request

Query parameters

afterstring

The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.

archivedboolean

Whether to return only results that have been archived.

Default false

associationsarray<string>

A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.

limitinteger (int32)

The maximum number of results to display per page.

Default 10

propertiesarray<string>

A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.

propertiesWithHistoryarray<string>

A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of contacts that can be read by a single request.

Response

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

pagingobject

nextobject2 fields

Specifies the paging information needed to retrieve the next set of results in a paginated API response

resultsarray<object>

archivedbooleanrequired

Whether the object is archived.

archivedAtstring (date-time)

The timestamp when the object was archived, in ISO 8601 format.

associationsobject

A list defining relationships with other objects.

createdAtstring (date-time)required

The timestamp when the object was created, in ISO 8601 format.

idstringrequired

The unique ID of the object.

objectWriteTraceIdstring

An identifier used for tracing the creation or update request of the object.

propertiesobjectrequired

Key value pairs representing the properties of the object.

propertiesWithHistoryobject

Key-value pairs representing the properties of the object along with their history.

updatedAtstring (date-time)required

The timestamp when the object was last updated, in ISO 8601 format.

urlstring

The URL on the API that provide direct navigation to the corresponding UI pages for the connectors.

warningsarray<object>3 fields

json

{
  "results": [
    {
      "archived": false,
      "createdAt": "2025-01-01T00:00:00Z",
      "id": "string",
      "properties": {},
      "updatedAt": "2025-01-01T00:00:00Z",
      "archivedAt": "2025-01-01T00:00:00Z",
      "associations": {},
      "objectWriteTraceId": "string",
      "propertiesWithHistory": {},
      "url": "string",
      "warnings": [
        {
          "category": "string",
          "context": {},
          "message": "string"
        }
      ]
    }
  ],
  "paging": {
    "next": {
      "after": "NTI1Cg%3D%3D",
      "link": "?after=NTI1Cg%3D%3D"
    }
  }
}

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

Was this page helpful?