Companies

Company List Entries

Company Lists

The unique ID of the person or organization to add to this list. Opportunities cannot be created using this endpoint.

Parameters

List Entries

Lists

Notes

Opportunities

Person Lists Entries

Person Lists

Persons

Affinity

Get current user

Paginate through Companies in Affinity.
Returns basic information and non-list-specific field data on each Company.

To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter
to specify the Fields for which you want data returned.
These Field IDs and Types can be found using the GET `/v2/companies/fields` endpoint.
When no `fieldIds` or `fieldTypes` are provided, Companies will be returned without any field data attached.
To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this:
`?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`.

Requires the "Export All Organizations directory" [permission](#section/Getting-Started/Permissions).

Get all Companies

Returns basic information and non-list-specific field data on the requested Company.

To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter
to specify the Fields for which you want data returned.
These Field IDs and Types can be found using the GET `/v2/companies/fields` endpoint.
When no `fieldIds` or `fieldTypes` are provided, Companies will be returned without any field data attached.
To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this:
`?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`.

Requires the "Export All Organizations directory" [permission](#section/Getting-Started/Permissions).

Get a single Company

Returns metadata on non-list-specific Company Fields.

Use the returned Field IDs to request field data from the GET `/v2/companies` and GET `/v2/companies/{id}` endpoints.

Get metadata on Company Fields

Returns metadata for all the Lists on which the given Company appears.

Get a Company's Lists

Paginate through the List Entries (AKA rows) for the given Company across all Lists.
Each List Entry includes field data for the Company, including list-specific field data.
Each List Entry also includes metadata about its creation, i.e., when it was added to the List and by whom.

Requires the "Export data from Lists" [permission](#section/Getting-Started/Permissions).

Get a Company's List Entries

Get metadata on all Lists

Get metadata on a single List

Paginate through the List Entries (AKA rows) on a given List.
Returns basic information and field data, including list-specific
field data, on each Company, Person, or Opportunity on the List.
List Entries also include metadata about their creation,
i.e., when they were added to the List and by whom.

To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter
to specify the Fields for which you want data returned.
These Field IDs and Types can be found using the GET `/v2/lists/{listId}/fields` endpoint.
When no `fieldIds` or `fieldTypes` are provided, List Entries will be returned without any field data attached.
To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this:
`?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`.

Requires the "Export data from Lists" [permission](#section/Getting-Started/Permissions).

Get all List Entries on a List

Returns metadata on the Fields available on a single List.

Use the returned Field IDs to request field data from the GET `/v2/lists/{listId}/list-entries` endpoint.

Get metadata on a single List's Fields

Returns metadata on the Saved Views on a List.

Get metadata on Saved Views

Get metadata on a single Saved View

Paginate through the List Entries (AKA rows) on a given Saved View.
Use this endpoint when you need to filter entities or only want **some**
field data to be returned: This endpoint respects the filters set on a Saved View
via web app, and only returns field data corresponding to the columns that have been
pulled into the Saved View via web app.

Though this endpoint respects the Saved View's filters and column/Field selection,
it does not yet preserve sort order. This endpoint also only supports **sheet-type
Saved Views**, and not board- or dashboard-type Saved Views.

See the [Data Model](#section/Data-Model) section for more information about Saved Views.

Requires the "Export data from Lists" [permission](#section/Getting-Started/Permissions).

Get all List Entries on a Saved View

Paginate through Opportunities in Affinity.
Returns basic information but **not** field data on each Opportunity.

To access field data on Opportunities, use the `/lists/{list_id}/list-entries`
or the `/v2/lists/{list_id}/saved-views/{view_id}/list-entries` GET endpoint.

Requires the "Export data from Lists" [permission](#section/Getting-Started/Permissions).

Get all Opportunities

Returns basic information but **not** field data on the requested Opportunity.

To access field data on Opportunities, use the `/lists/{list_id}/list-entries`
or the `/v2/lists/{list_id}/saved-views/{view_id}/list-entries` GET endpoint.

Requires the "Export data from Lists" [permission](#section/Getting-Started/Permissions).

Get a single Opportunity

Paginate through Persons in Affinity.
Returns basic information and non-list-specific field data on each Person.

To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter
to specify the Fields for which you want data returned.
These Field IDs and Types can be found using the GET `/v2/persons/fields` endpoint.
When no `fieldIds` or `fieldTypes` are provided, Persons will be returned without any field data attached.
To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this:
`?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`.

Requires the "Export All People directory" [permission](#section/Getting-Started/Permissions).

Get all Persons

Returns basic information and non-list-specific field data on the requested Person.

To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter
to specify the Fields for which you want data returned.
These Field IDs and Types can be found using the GET `/v2/persons/fields` endpoint.
When no `fieldIds` or `fieldTypes` are provided, Persons will be returned without any field data attached.
To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this:
`?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`.

Requires the "Export All People directory" [permission](#section/Getting-Started/Permissions).

Get a single Person

Returns metadata on non-list-specific Person Fields.

Use the returned Field IDs to request field data from the GET `/v2/persons` and GET `/v2/persons/{id}` endpoints.

Get metadata on Person Fields

Returns metadata for all the Lists on which the given Person appears.

Get a Person's Lists

Paginate through the List Entries (AKA rows) for the given Person across all Lists.
Each List Entry includes field data for the Person, including list-specific field data.
Each List Entry also includes metadata about its creation, i.e., when it was added to the List and by whom.

Requires the "Export data from Lists" [permission](#section/Getting-Started/Permissions).

Get a Person's List Entries

Salesforce

HubSpot

Microsoft Dynamics 365

Zoho CRM

Pipedrive

Freshsales

Keap

SugarCRM

Outreach

Xero

ActiveCampaign

Capsule CRM

Salesloft

Agile CRM

SalesForce Pardot

SharpSpring

Teamleader

Insightly

Zendesk

Sage Accounting

Attio

Copper

Intercom

Zoho Books

Front

Close

Freshdesk

Breezy HR

Exact Online

Mautic

# Realtime Full two-way Sync of Companies

This scenario enables your application to fully sync Companies between your app and any external application in both directions. It handles the initial import/export of Companies and then sends events when a Company is created, updated, or deleted on any side, as close to real-time as possible.

Company fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Companies in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Companies to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Companies

Bi-directional realtime sync of Companies with records deduplication

Mailchimp

NetSuite

AWeber

Apollo.io

GoHighLevel

Ontraport

Jobnimbus

# Continuous Import of Contacts to Your App

This scenario enables your application to continuously sync Contacts from any external application to your app's API. It handles the initial import of Contacts and keeps them synchronized when a Contact is created, updated, or deleted in the external application.

When receiving Contacts data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Contacts to my App

Import Contacts and receive created/updated or deleted events

# Create Note

This scenario allows your application to create a Note in any external application in the same way. 
You will pass Note fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Note with and configure mapping to our default model

2. **Create Note API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Note data into a format compatible with the selected external application.
   - It then makes an API call to create the Note in that specific application.


Create Note

# Delete Company

This scenario allows your application to delete a Company from any external application. 
You will pass ID of the Company you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Company API call**:
   - Call Integration.app REST API or SDK with ID of the Company you want to delete and Integration.app will send the correct request to the external app.


Delete Company

Deletes Company in any external application

# Get all Notes

This scenario enables your application to get a complete list of Notes from any external application to your app's API in the same way. 

When receiving Notes data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Notes along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Notes page by page.


Get all Notes

Imports all Notes from any external application to your App.

# Get all Companies

This scenario enables your application to get a complete list of Companies from any external application to your app's API in the same way. 

When receiving Companies data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Companies along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Companies page by page.


Imports all Companies from any external application to your App.

# Delete Note

This scenario allows your application to delete a Note from any external application. 
You will pass ID of the Note you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Note API call**:
   - Call Integration.app REST API or SDK with ID of the Note you want to delete and Integration.app will send the correct request to the external app.


Delete Note

# Get all Contacts

This scenario enables your application to get a complete list of Contacts from any external application to your app's API in the same way. 

When receiving Contacts data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Contacts along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Contacts page by page.


Get all Contacts

Imports all Contacts from any external application to your App.

Woosender

# Enrich newly created Contacts

This scenario enables your application to enrich with the new data any newly createad Contacts in external application. 

It handles subscription to the created events and Contact fields mapping from your application's schema to the application-specific schema.

## How It Works
1. **Configuration**:
   - You will setup the schema of fields that you wish to enrich Contact with and configure mapping to our default model.
   - If needed - your customer can customize this mapping based on their specific setup or even custom fields

2. **Enable receiving of Contact created events**:
   - Enable subscription via a single API or SDK call to continuously receive created events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

2. **React to created Contacts**:
   - Integration.app flow will be launched when new Contact is created
   - It will send existing data to your app API, so you can decide how to enrich. Your API will return enriched data.
   - Integration.app will send enriched data to the external application mapped to the supported format based on the configuration above


Continuously Enrich Contacts

Receive all newly created contacts, send it to your app API to enrich with the new data and update contact back

# Create Company

This scenario allows your application to create a Company in any external application in the same way. 
You will pass Company fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Company with and configure mapping to our default model

2. **Create Company API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Company data into a format compatible with the selected external application.
   - It then makes an API call to create the Company in that specific application.


Create Company

Creates Company in any external application

# Realtime Full two-way Sync of Notes

This scenario enables your application to fully sync Notes between your app and any external application in both directions. It handles the initial import/export of Notes and then sends events when a Note is created, updated, or deleted on any side, as close to real-time as possible.

Note fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Notes in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Notes to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Notes

Bi-directional realtime sync of Notes with records deduplication

# Continuous Import of Companies to Your App

This scenario enables your application to continuously sync Companies from any external application to your app's API. It handles the initial import of Companies and keeps them synchronized when a Company is created, updated, or deleted in the external application.

When receiving Companies data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Companies to my App

Import Companies and receive created/updated or deleted events

# Delete Contact

This scenario allows your application to delete a Contact from any external application. 
You will pass ID of the Contact you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Contact API call**:
   - Call Integration.app REST API or SDK with ID of the Contact you want to delete and Integration.app will send the correct request to the external app.


Delete Contact

Deletes Contact in any external application

# Create Contact

This scenario allows your application to create a Contact in any external application in the same way. 
You will pass Contact fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Contact with and configure mapping to our default model

2. **Create Contact API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Contact data into a format compatible with the selected external application.
   - It then makes an API call to create the Contact in that specific application.


Create Contact

Creates Contact in any external application

# Continuous Import of Notes to Your App

This scenario enables your application to continuously sync Notes from any external application to your app's API. It handles the initial import of Notes and keeps them synchronized when a Note is created, updated, or deleted in the external application.

When receiving Notes data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Notes to my App

Import Notes and receive created/updated or deleted events

# Update Note

This scenario allows your application to update a Note in any external application in the same way. 
You will pass  ID of the Note you want to update and Note fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Note with and configure mapping to our default model

2. **Create Note API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Note data into a format compatible with the selected external application.
   - It then makes an API call to update the Note in that specific application.


Update Note

# Update Contact

This scenario allows your application to update a Contact in any external application in the same way. 
You will pass  ID of the Contact you want to update and Contact fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Contact with and configure mapping to our default model

2. **Create Contact API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Contact data into a format compatible with the selected external application.
   - It then makes an API call to update the Contact in that specific application.


Update Contact

Updates Contact in any external application

# Enrich newly created Companies

This scenario enables your application to enrich with the new data any newly createad Companies in external application. 

It handles subscription to the created events and Company fields mapping from your application's schema to the application-specific schema.

## How It Works
1. **Configuration**:
   - You will setup the schema of fields that you wish to enrich Company with and configure mapping to our default model.
   - If needed - your customer can customize this mapping based on their specific setup or even custom fields

2. **Enable receiving of Company created events**:
   - Enable subscription via a single API or SDK call to continuously receive created events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

2. **React to created Companies**:
   - Integration.app flow will be launched when new Company is created
   - It will send existing data to your app API, so you can decide how to enrich. Your API will return enriched data.
   - Integration.app will send enriched data to the external application mapped to the supported format based on the configuration above


Continuously Enrich Companies

Receive all newly created companies, send it to your app API to enrich with the new data and update company back

# Update Company

This scenario allows your application to update a Company in any external application in the same way. 
You will pass  ID of the Company you want to update and Company fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Company with and configure mapping to our default model

2. **Create Company API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Company data into a format compatible with the selected external application.
   - It then makes an API call to update the Company in that specific application.


Update Company

Updates Company in any external application

# Realtime Full two-way Sync of Contacts

This scenario enables your application to fully sync Contacts between your app and any external application in both directions. It handles the initial import/export of Contacts and then sends events when a Contact is created, updated, or deleted on any side, as close to real-time as possible.

Contact fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Contacts in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Contacts to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Contacts

Bi-directional realtime sync of Contacts with records deduplication

# Note Unified API

This scenario contains the complete Notes Unified API into your workspace. You will be able to seamlessly create, update, delete, and search Notes while also receiving notifications on creation, updates, and deletions of Notes in external applications. 

Integration.app will automatically manage the mapping of data to the unified schema, eliminating any concerns about differences across external applications. Additionally, you’ll have the flexibility to customize mappings for specific applications or customers, ensuring compatibility with their unique configurations when needed.


Notes Unified API

# Contact Unified API

This scenario contains the complete Contacts Unified API into your workspace. You will be able to seamlessly create, update, delete, and search Contacts while also receiving notifications on creation, updates, and deletions of Contacts in external applications. 

Integration.app will automatically manage the mapping of data to the unified schema, eliminating any concerns about differences across external applications. Additionally, you’ll have the flexibility to customize mappings for specific applications or customers, ensuring compatibility with their unique configurations when needed.


Contacts Unified API

# Company Unified API

This scenario contains the complete Companies Unified API into your workspace. You will be able to seamlessly create, update, delete, and search Companies while also receiving notifications on creation, updates, and deletions of Companies in external applications. 

Integration.app will automatically manage the mapping of data to the unified schema, eliminating any concerns about differences across external applications. Additionally, you’ll have the flexibility to customize mappings for specific applications or customers, ensuring compatibility with their unique configurations when needed.


Companies Unified API

Location

The source of the data in this Field (if it is enriched)

Field Name	API Key	Type
Query	query	object
Cursor	query.cursor	string
Limit	query.limit	integer
Headers	headers	object

Field Name	API Key	Type	Description
Data	data	array of items	A page of FieldMetadata results
Id	item.id	string	The field's unique identifier
Name	item.name	string	The field's name
Type	item.type	string	The field's type
Enrichment Source	item.enrichmentSource	string	The source of the data in this Field (if it is enriched)

Affinity API Integration Profile

Get metadata on Company Fields in Affinity API

Build every single integration your customers need with AI