CRM API

Opportunities

Companies

Leads

Contacts

Pipelines

Notes

Activities

Users

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

Description

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

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 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.

HubSpot

Supported resources

Details