CRM API

Opportunities

Companies

Leads

Contacts

Pipelines

Notes

Activities

Users

Custom Objects

Custom Object Schemas

Planhat is an enterprise level Customer Success platform, simplifying customer success and lowering churn for businesses globally.

Planhat

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.

edge-case

Birth Date

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

Currency

UNKNOWN_CURRENCY

medium

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

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.

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

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'

critical

The company the contact is associated with.

The name of the company the contact is associated with.

Current Balance

Description

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

Photo URL

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

high

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

filter

sort

x-apideck-app-id

ID of the consumer which you want to get or push data from

x-apideck-consumer-id

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

cursor

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

fields

Number of results to return. Minimum 1, Maximum 200, Default 20

limit

object_id

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

pass_through

Include raw response. Mostly used for debugging purposes

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-service-id

Type

Updated since (timestamp)

The field on which to sort the Activities

The time the attendee was created (ISO 8601)

Whether the attendee is the organizer of the activity

The last time the attendee was updated (ISO 8601)

Contains parameter or domain specific information related to the error and why it occurred.

Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)

A human-readable message providing more details about the error.

The name which you used in opening your bank account.

Bank Account Name

A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number.

Bank Account Number

Account Type

A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.

Bank Code

Bank Name

A branch identifier is a unique identifier for a branch of a bank or financial institution.

Branch Identifier

A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution.

BSB Number

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

Country Code

The International Bank Account Number (IBAN).

A routing number is a nine-digit code used to identify a financial institution in the United States.

Routing number

SpaceX

Unique identifier for the associated company of the contact to filter on

Unique identifier for the owner of the contact to filter on

Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.

The service provider's ID of the entity that triggered this event

The type entity that triggered this event

The current count this request event has been attempted

ISO Datetime for when the original event occurred

The timestamp when the custom object was created

The unique identifier of the user who created the custom object

The unique identifier of the custom object

The unique identifier of the owner of the custom object

The timestamp when the custom object was last updated

The unique identifier of the user who last updated the custom object

Whether the custom object schema is active

The timestamp when the custom object schema was created

The ID of the user who created the custom object schema

The description of the custom object schema

The unique identifier of the custom object schema

The timestamp when the custom object schema was last updated

The ID of the user who last updated the custom object schema

Whether the custom object schema is visible in the UI

The field on which to sort the Custom Object Schemas

The field on which to sort the Custom Objects

The name of the company the lead is associated with.

Links to navigate to previous or next pages through the API

Link to navigate to the current page through the API

Link to navigate to the previous page through the API

The field on which to sort the Opportunities

Simple object allowing any properties for direct extension.

Array of objects for structured data modifications via paths.

Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request.

Identifier for the service to which this pass_through should be applied.

All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads)

The area code of the phone number, e.g. 323

Area code

The country code of the phone number, e.g. +1

Country code

Phone extension

Phone number

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.

Raw response from the integration when raw=true query param is provided

URL of the social link, e.g. https://www.twitter.com/apideck

The direction in which to sort the results

Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 6585)

A object containing a unique identifier for the resource that was created, updated, or deleted.

Planhat

Supported resources

Details