CRM API

Opportunities

Companies

Leads

Contacts

Pipelines

Notes

Activities

Users

Custom Objects

Custom Object Schemas

Lists

HubSpot is your all-in-one stop for all of your marketing software needs.

oauth_credentials

HubSpot

edge-case

The company the contact is associated with.

The name of the company the contact is associated with.

Current Balance

medium

When custom mappings are configured on the resource, the result is included here.

Description

language code according to ISO 639-1. For the United States - EN

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Photo URL

critical

The name of the company the lead is associated with.

Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

Currency

UNKNOWN_CURRENCY

high

An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity.

ABN Branch

An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia.

ABN or TFN

The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank.

Birth Date

First name

The industry represents the type of business the company is in.

Last name

Name

The ownership indicates the type of ownership of the company.

A payee number is a unique number that identifies a payee for tax purposes.

Payee number

Read-only

Company Row Type

A sales tax number is a unique number that identifies a company for tax purposes.

Sales tax number

A formal salutation for the person. For example, 'Mr', 'Mrs'

The actual closing date for the opportunity. If close_date is null, the opportunity is not closed yet.

The unique identifier of the company associated with the opportunity.

The name of the company associated with the opportunity.

The unique identifier of the contact associated with the opportunity.

An array of unique identifiers of all contacts associated with the opportunity.

The date and time when the opportunity was created.

The unique identifier of the user who created the opportunity.

The date and time when the opportunity was last contacted.

The date and time when the lead associated with the opportunity was created.

The date and time when the stage of the opportunity was last changed.

Indicates whether the opportunity has been deleted.

The expected revenue from the opportunity

The number of interactions with the opportunity.

The date and time of the last activity associated with the opportunity.

The unique identifier of the lead associated with the opportunity.

The source of the lead associated with the opportunity.

The unique identifier of the reason why the opportunity was lost.

The monetary value associated with the opportunity

The unique identifier of the user who owns the opportunity.

The unique identifier of the pipeline associated with the opportunity

The unique identifier of the stage in the pipeline associated with the opportunity.

The unique identifier of the primary contact associated with the opportunity.

The unique identifier of the source of the opportunity.

The unique identifier of the current status of the opportunity.

The date and time when the opportunity was last updated.

The unique identifier of the user who last updated the opportunity.

The probability of winning the opportunity, expressed as a percentage.

The unique identifier of the reason why the opportunity was won.

The date and time when the object was created.

Created at (timestamp)

The order in which the Pipeline is displayed in the UI.

The date and time when the object was last updated.

Updated at (timestamp)

Whether the Pipeline has win probability enabled or not.

Whether the Activity is an all day event or not

Whether the activity is a child of another activity or not

The date and time when the activity was created

The custom object related to the activity

Done

The third-party API ID of original entity

Whether the Activity is a group event or not

Name of the contact person at the address

country code according to ISO 3166-1 alpha-2.

Address field that holds a sublocality, such as a county

Line 1 of the address e.g. number, street, suite, apt #, etc.

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

Row version

Salutation of the contact person at the address

The address string. Some APIs don't provide structured address data.

Note (internal)

The date and time when the activity was last updated

Meeting ID

Meeting URL

The activity that is related to the note.

The opportunity that is related to the note.

The timestamp when the note was last updated

Company name

The date and time when the user was created.

The department the person is currently in. [Deprecated](https://developers.apideck.com/changelog) in favor of the dedicated department_id and department_name field.

Department

The division the person is currently in. Usually a collection of departments or teams or regions.

Division

An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.

Employee number

Job title

The date and time when the user was last updated.

The date and time when the List was created.

The unique identifier of the user who created the List.

The filter criteria used to determine which records belong to a dynamic List. Shape is connector-native and passed through largely as-is (e.g. Close returns its own nested query-tree structure) rather than normalized to a common format.

The unique identifier of the folder the List is organized under.

Whether the List is dynamic, meaning its records are automatically kept up to date based on filter criteria. This is a boolean mirror of `type` (`true` when `type` is `dynamic`, `false` when `static`), provided for callers that prefer a boolean check over a string comparison.

Whether the List has been marked as a favorite.

Whether the List is a system-generated List.

The type of CRM records the List contains. Normalized to a lowercase plural noun for the vendor's standard object types (e.g. contacts, companies, opportunities, leads, tickets, campaigns, tasks, events); for vendor-specific or custom object types the raw downstream identifier is passed through unchanged, following the connector's native casing (e.g. a HubSpot custom objectTypeId like 2-12345 or a Salesforce custom object API name), so a raw value may not always be distinguishable from a normalized one. This field is intentionally open-ended — no closed enum is enforced.

The unique identifier of the user who owns the List.

The number of records currently in the List.

Whether the List is static (a fixed set of records) or dynamic (a saved segment that is automatically kept up to date based on filter criteria).

The date and time when the List was last updated.

The unique identifier of the user who last updated the List.

The visibility of the List. Which of these values a given connector can return depends on its native sharing model — see the connector-specific gotchas below for details.

Lead API

Third-party scripts API

Hubspot will only return activities from the last 30 days when using the `filter[updated_since]` parameter, with a maximum of 10.000 records. More info [here](https://legacydocs.hubspot.com/docs/methods/engagements/get-recent-engagements). Use `filter[type]=call` to get custom fields for call activities. When using both `filter[type]=call` and `filter[updated_since]` together, you will get partial response data as the calls search endpoint does not support many data fields. Use only one filter to get better data fields. `filter[contact_id]` returns **all** activity types (calls, emails, meetings, notes, and tasks) associated with the contact, served by HubSpot's legacy associated-engagements API. Two interactions to note: combining `filter[contact_id]` with `filter[updated_since]` is not supported — the contact filter takes precedence and the date filter is silently ignored (the associated-engagements endpoint has no date filter). And `filter[type]` narrows the result only when `type=call` (returning that contact's calls); any other `type` value is ignored and all activity types are still returned.

To update custom fields for call activities, use `"type": "call"` in the request body.

When using a filter or sorting for companies, Hubspot will only return a maximum of 10.000 companies.

When using a filter or sorting for contacts, Hubspot will only return a maximum of 10.000 contacts.

When creating a contact, it is advised to always include an unique email address since Hubspot uses it to prevent duplicate contacts in HubSpot. More info on the [Hubspot developer docs](https://developers.hubspot.com/docs/api/crm/contacts).

When using a filter or sorting for leads, Hubspot will only return a maximum of 10.000 leads.

When creating a lead, it is advised to always include an unique email address since Hubspot uses it to prevent duplicate contacts in HubSpot. More info on the [Hubspot developer docs](https://developers.hubspot.com/docs/api/crm/contacts).

HubSpot's list-memberships endpoint returns only the record id and the timestamp at which
the record joined the list, so `object_type` is always `null` for HubSpot members. The
record type is a property of the List itself, not of each member — read `object_type` from
`GET /crm/lists/{id}` and apply it to every member of that list.

Members are returned sorted by record id ascending, not by the order records were added to
the list. For dynamic lists the membership is a saved segment evaluated by HubSpot, so the
result is a point-in-time snapshot rather than a stored set.


HubSpot's Lists v3 API does not expose `description`, `visibility`, `folder_id`, `owner_id`, `is_favorite`, `is_default`, or `is_system`, and `custom_fields` and `tags` are not mapped, so these fields are not returned for HubSpot. `filter_criteria` is not mapped in v1 (HubSpot's `filterBranch` is available downstream via `includeFilters=true` but is not requested). HubSpot's three list processing types map onto `type` as follows: DYNAMIC lists are returned as `dynamic`; MANUAL and SNAPSHOT lists are both returned as `static`.


HubSpot's Lists v3 API does not expose `description`, `visibility`, `folder_id`, `owner_id`, `is_favorite`, `is_default`, or `is_system`, and `custom_fields` and `tags` are not mapped, so these fields are not returned for HubSpot. `filter_criteria` is not mapped in v1 (HubSpot's `filterBranch` is available downstream via `includeFilters=true` but is not requested). HubSpot's three list processing types map onto `type` as follows: DYNAMIC lists are returned as `dynamic`; MANUAL and SNAPSHOT lists are both returned as `static`. A list id that does not exist in HubSpot returns a 404 error from the downstream API.


Hubspot will only return activities from the last 30 days when using the `filter[updated_since]` parameter, with a maximum of 10.000 records. More info [here](https://legacydocs.hubspot.com/docs/methods/engagements/get-recent-engagements). Use `filter[type]=call` to get custom fields for call activities. When using both `filter[type]=call` and `filter[updated_since]` together, you will get partial response data as the calls search endpoint does not support many data fields. Use only one filter to get better data fields.

When using a filter or sorting for opportunities, Hubspot will only return a maximum of 10.000 opportunities and omit the company_id, primary_contact_id, company_id, contact_ids, lead_id and contact_id.

HubSpot allows a deal to have no name, and its Search API omits blank properties from results. `title` is always returned, but it will be an **empty string** for such deals rather than a substituted placeholder — an empty `title` means the deal genuinely has no name in HubSpot, not that the value was unavailable. Treat `title` as possibly empty when using it as a display label.


HubSpot does not expose a cross-page total record count on this endpoint. `meta.total_count` will not appear.


HubSpot owners are mapped to CRM users in Apideck. HubSpot owners and HubSpot users (people who can log into HubSpot) aren't necessarily the same, as you may have owners created through an integration.

HubSpot

Details