CRM API

Opportunities

Companies

Leads

Contacts

Pipelines

Notes

Activities

Users

Custom Objects

Custom Object Schemas

Lists

Close is the sales CRM designed to help small and medium-sized businesses close more deals. Build relationships, track communications, and manage your sales pipeline.

Close

edge-case

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

medium

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

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.

critical

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'

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

Description

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 company the contact is associated with.

The name of the company the contact is associated with.

Current Balance

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

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

Close Smart Views are always `dynamic` saved queries; `filter_criteria` carries Close's structured `s_query` definition, falling back to the older `query` field for saved searches created before Close's structured-search migration. `record_count`, `folder_id`, `created_by`/`updated_by`, the favorite/default/system flags, `custom_fields`, and `tags` are not available. `visibility` derives from `is_shared`, and `owner_id` reflects the saved search's `user_id`; every saved search observed in testing (shared and private alike) had a `user_id`, so whether `owner_id` is ever genuinely null for organization-wide views has not been confirmed against a real account. The list operation only returns saved searches of type lead, contact, or opportunity; saved searches of other types (call, email, sms, meeting, note, whatsapp_message, custom_activity, form_submission) are excluded from the list but remain retrievable by id, with `object_type` set to the raw Close type. Close's saved-search endpoint ignores server-side offsets, so results are fetched as a single page (up to Close's undeclared server default of around 100 smart views) and paginated virtually; accounts with more than that many smart views will have the overflow silently dropped, with no field in the response indicating truncation occurred.


Close Smart Views are always `dynamic` saved queries; `filter_criteria` carries Close's structured `s_query` definition, falling back to the older `query` field for saved searches created before Close's structured-search migration. `record_count`, `folder_id`, `created_by`/`updated_by`, the favorite/default/system flags, `custom_fields`, and `tags` are not available. `visibility` derives from `is_shared`, and `owner_id` reflects the saved search's `user_id`; every saved search observed in testing (shared and private alike) had a `user_id`, so whether `owner_id` is ever genuinely null for organization-wide views has not been confirmed against a real account. A saved search of any type is retrievable by id, including types the list operation excludes (call, email, sms, meeting, note, whatsapp_message, custom_activity, form_submission), in which case `object_type` is set to the raw Close type.


When creating a note in Close, the content of the note should be sent in html surrounded by the <body> tags and at least other inner element. If these tags are not sent, unify will surround the note with <body> and <p> tags.

When updating a note in Close, the content of the note should be sent in html surrounded by the <body> tags and at least other inner element. If these tags are not sent, unify will surround the note with <body> and <p> tags.

Close

Details