CRM API

Opportunities

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.

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.

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 pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

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.

critical

Companies

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

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'

Leads

The name of the company the lead is associated with.

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

high

Contacts

The company the contact is associated with.

The name of the company the contact is associated with.

Current Balance

Description

Photo URL

Pipelines

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.

Notes

The activity that is related to the note.

The opportunity that is related to the note.

The timestamp when the note was last updated

Activities

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

Users

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.

Act! provides everything you need to market like a pro, turn leads into sales, and win raving fans for life. Get on the path to growth!

Integrated email marketing, marketing automation, and small business CRM. Save time while growing your business with sales automation.

ActiveCampaign

Lead API

Unlock your team's true potential with Attio, the data-driven CRM for modern teams. Manage everything from sales leads through to recruitment pipelines.

Attio

Close is the inside sales CRM of choice for startups and SMBs. Make more calls, send more emails and close more deals starting today.

Close.io

When you need CRM software that works with G Suite, you need Copper. Give us a try and see how we can help your business build stronger customer relationships.

Copper

Flexmail is a Belgian company that offers a user-friendly and cloud-based tool to run your email campaigns, build your target audiences and reach your goals.

Flexmail

Email Marketing API

Freshsales is an online, cloud-based CRM with Integrated phone and email, User behavior tracking, Lead scoring and more.

Freshworks CRM

Google Contacts, the address book built into Gmail, lets you keep track of all your contacts, see when you last interacted with them, and more.

oauth_credentials

Google Contacts

Business management software with top-class invoicing, accounting, inventory and CRM with projects in a super intuitive single platform that suits every type of business.

connection

image

Holded

HRIS API

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

HubSpot

Third-party scripts API

Dynamics CRM is a leading customer resource management and enterprise resource planning software.

Microsoft Dynamics CRM

Microsoft Outlook

From ERP to CRM, eCommerce and CMS. Download Odoo or use it in the cloud. Grow Your Business.

Odoo

Pipedrive is the easy-to-use, #1 user-rated CRM tool. Get more qualified leads and grow your business. Sign up for a 14-day free trial.

Pipedrive

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

Planhat

The #1 simple CRM for small businesses selling B2B. Integrate with Google & Outlook. Be fully mobile. Automate your CRM from existing data.

Salesflare

CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.

Salesforce

Faced with a mountain of administration? Don’t panic. We’ll guide you over.

Teamleader

Zendesk Sell (formerly Base) is a sales automation tool to enhance productivity, processes, and pipeline visibility for sales teams.

Zendesk Sell

Zoho makes it easy to get the complete picture of your sales cycle and stay on top of your business opportunities. Never lose another lead again.

Zoho CRM

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

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

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

CRM API Reference