Skip to main content

List contacts

GET 
/hubspot/contacts

NOTE: To use the Data Listing API you need to use the Supaglue Managed Destination and select Standard Objects to be synced.

Request​

Query Parameters

    modified_after date-time

    If provided, will only return objects modified after this datetime. Datetime must be in ISO 8601 format and URI encoded.

    Example: 2023-02-23T00:00:00Z
    page_size string

    Number of results to return per page. (Max: 1000)

    Example: 123
    cursor string

    The pagination cursor value

    Example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Header Parameters

    x-customer-id stringrequired

    The customer ID that uniquely identifies the customer in your application

    Example: my-customer-1

Responses​

Contacts

Schema
    pagination objectrequired
    next stringnullablerequired
    previous stringnullablerequired
    total_count number
    records object[]required
  • Array [
    • id stringrequired

    the unique identifier for the contact. This field is set automatically and cannot be edited. This can be used when updating contacts through importing or through API.

    email stringnullablerequired

    the contact's primary email address.

    associatedcompanyid stringnullablerequired
    firstname stringnullablerequired

    the contact's first name.

    phone stringnullablerequired

    the contact's primary phone number. The phone number is validated and formatted automatically by HubSpot based on the country code. You can select to turn off automatic formatting on a contact record, either when editing the Phone number property, or adding a phone number to call.

    is_deleted booleanrequired

    Indicates whether the object has been moved to the Recycle Bin (true) or not (false).

    lastname stringnullablerequired

    the contact's last name.

    city stringnullablerequired

    the contact's city of residence.

    country stringnullablerequired

    the contact's country of residence. This might be set via import, form, or integration.

    zip stringnullablerequired

    the contact's zip code.

    state stringnullablerequired

    the contact's state of residence.

    address stringnullablerequired

    the contact's street address, including apartment or unit #.

    mobilephone stringnullablerequired

    the contact's mobile phone number. The phone number is validated and formatted automatically by HubSpot based on the country code. You can select to turn off automatic formatting on a contact record, either when editing the Mobile phone number property, or adding a phone number to call.

    hubspot_owner_id stringnullablerequired

    the owner of the contact. This can be any HubSpot user or Salesforce integration user and can be set manually or via Workflows. You can assign additional users to the contact record by creating a custom HubSpot user field type property.

    fax stringnullablerequired

    the contact's primary fax number.

    jobtitle stringnullablerequired

    the contact's job title.

    createdate date-timerequired

    the date that the contact was created in your HubSpot account.

    notes_last_updated date-timerequired

    the last date and time a note, call, tracked and logged sales email, meeting, LinkedIn/SMS/WhatsApp message, task, or chat was logged on the contact record. This is set automatically by HubSpot based on the most recent date/time set for an activity. For example, if a user logs a call and indicates that it occurred the day before, the Last activity date property will show yesterday's date.

    raw_data objectrequired

    The raw data returned by the provider.

    property name* any

    The raw data returned by the provider.

  • ]
Loading...