Welcome to Affinity API v2! This API provides a RESTful interface for building internal apps, automated workflows, and other integrations on top of the core data models in Affinity, and for connecting Affinity to the rest of your tech and data stack.
Please note that this new version of the API is not at feature parity with Affinity API v1. We will add to this new version to cover more of v1's functionality over time. This API version is also only available on select Affinity license types. See this Help Center article or contact your Customer Success Manager for more information.
All Affinity API endpoints use the base URL https://api.affinity.co
. All v2 endpoint paths start
with /v2
. Requests must be sent over HTTPS.
The first few sections of these docs cover general information on the API. Each subsequent section covers a set of API endpoints.
Each endpoint is documented with its accepted request parameters, expected response shapes, and a sample request and response. Please note that the shape of a given response can vary depending on what "type" of object or data is being returned. When this is the case, the response documentation will include a dropdown that can be used to select the "type" for which to display the response shape.
Affinity API v2 uses API keys and bearer authentication (this is an important difference from Affinity API v1's use of basic authentication).
To generate an API key, navigate to the Settings page in the Affinity web app. You will need the "Generate an API key" role-based permission controlled by your Affinity admin to be able to do this. See this Help Center article for full instructions on API key generation, and this article for more information on role-based permissions in Affinity.
Currently, we support one API key per user in your Affinity account. Your API key is able to read data and perform actions in Affinity on your behalf, so keep it safe as you would a password.
Provide your API key as your bearer authentication token to start making calls to Affinity API v2.
You must have the "Generate an API key" permission to be able to work with the Affinity API. Most users in most Affinity accounts with API access have this by default — Contact your Affinity admin if you are not able to generate an API key, and see this article for more information on role-based permissions in Affinity.
The Affinity API respects sharing permissions that are set in-product. For example, if a given user does not have access to a list, note, or interaction in-product, they will not be able to see or modify it via API.
Many API endpoints also require endpoint-specific permissions that map to permissions in-product. These permissions, along with the "Generate an API key" permission, are managed by your Affinity admin in the Settings page:
API v2 Endpoint | Required Permission |
---|---|
GET /v2/companies |
"Export All Organizations directory" |
GET /v2/companies/{id} |
"Export All Organizations directory" |
GET /v2/companies/{id}/list-entries |
"Export data from Lists" |
GET /v2/persons |
"Export All People directory" |
GET /v2/persons/{id} |
"Export All People directory" |
GET /v2/persons/{id}/list-entries |
"Export data from Lists" |
GET /v2/opportunities |
"Export data from Lists" |
GET /v2/opportunities/{id} |
"Export data from Lists" |
GET /v2/lists/{listId}/list-entries |
"Export data from Lists" |
GET /v2/lists/{listId}/saved-views/{viewId}/list-entries |
"Export data from Lists" |
The Affinity API sets a limit on the number of calls that a user can make per minute, and that all the users on an account can make per month. It also sets a reasonable limit on the number of concurrent requests it will support from an account at one time.
Requests to both Affinity API versions will count toward the one pool of requests allowed for a user or account. Once a per-minute, monthly, or concurrent rate limit is hit, subsequent requests will return an error code of 429. We highly recommend designing your application to handle 429 errors.
To help protect our systems, API requests will be halted at 900 per user, per minute. We may also lower this limit on a temporary basis to manage API availability.
To protect our systems and manage availability across customers, we set a reasonable limit on concurrent requests at the account level. Customers should not expect to hit this limit unless they are hitting the API with heavy operations from many concurrent threads at once.
The overall number of requests you can make per month will depend on your account's plan tier. This monthly account-level limit resets at the end of each calendar month. Current rate limits by plan tier are:
Plan Tier | Calls Per Month |
---|---|
Essentials | None |
Scale | 100k |
Advanced | 100k |
Enterprise | Unlimited* |
*Per-Minute and Concurrent Request Limits still apply.
All API calls will return the following response headers with information about per-minute and monthly limits:
Header | Description |
---|---|
X-Ratelimit-Limit-User | Number of requests allowed per minute for the user |
X-Ratelimit-Limit-User-Remaining | Number of requests remaining for the user |
X-Ratelimit-Limit-User-Reset | Time in seconds before the limit resets for the user |
X-Ratelimit-Limit-Org | Number of requests allowed per month for the account |
X-Ratelimit-Limit-Org-Remaining | Number of requests remaining for the account |
X-Ratelimit-Limit-Org-Reset | Time in seconds before the limit resets for the account |
When an endpoint is expected to return multiple results, we break the results up into pages to make
them easier to handle. To cycle forward through multiple pages of data, look for the nextUrl
property in the pagination
portion of an API response, and use it for your next request. See
endpoint documentation for more information.
Here is a list of the error codes this API will generally return if something goes wrong (see endpoint documentation for endpoint-specific error information):
Error Code | Meaning |
---|---|
400 | Bad Request — See endpoint documentation for more information. |
401 | Unauthorized — Your API key is invalid. |
403 | Forbidden — Insufficient rights to a resource. |
404 | Not Found — Requested resource does not exist. See endpoint documentation for more information. |
405 | Method Not Allowed — The method being used is not supported for this resource. |
422 | Unprocessable Entity — Malformed parameters supplied. This can also happen in cases the parameters supplied logically cannot complete the request. In this case, an appropriate error message is delivered. |
429 | Too Many Requests — You have exceeded the rate limit. |
500 | Internal Server Error — We had a problem with our server. Try again later. |
503 | Service Unavailable — This shouldn't generally happen. Contact us if you encounter this error. |
There are a few types of Fields in Affinity, differentiated by the scope and source of their data:
Field Type | Description | Example Fields | Field ID Pattern |
---|---|---|---|
enriched |
Firmographic, funding, and people Fields populated by Affinity. These can be "Affinity Data" Fields or come from distinct data partners. | "Affinity Data: Description", "Dealroom: Number of Employees" | A string representing the enrichment source, followed by the field name, e.g. affinity-data-description or dealroom-number-of-employees . |
list |
Fields that are specific to the context of a given list. These can only be accessed through */list-entries endpoints in this version of the API. |
Default "Status" and "Amount" columns, custom columns that pertain to a given List of deals or founders | field- , followed by a unique integer, e.g. field-1234 |
global |
Fields that persist across an Affinity account and are not list-specific. | "My Firm's Founder Scoring Column" | field- , followed by a unique integer, e.g. field-1234 |
relationship-intelligence |
Fields populated by Affinity from users' email and calendar data that provide insight into your firm's relationship with a given Person/Company/Opportunity. | "Source of Introduction", "First Email", "Last Email", "First Event", "Last Event", "Next Event", "First Chat Message", "Last Chat Message", "Last Contact" | A string similar to the field's name in-product, e.g. source-of-introduction |
Field data can take a variety of shapes. These value types are described in the Affinity Help Center
here.
Here is a list of the same value types, as represented in this API. Notice how array types end with
-multi
:
Single Type | Array Type |
---|---|
text |
Not supported in Affinity |
number |
number-multi |
datetime |
Not supported in Affinity |
location |
location-multi |
dropdown |
dropdown-multi |
ranked-dropdown |
Not supported in Affinity |
person |
person-multi |
company |
company-multi |
filterable-text * |
filterable-text-multi * |
*Please note that filterable-text
and filterable-text-multi
are special types that operate
similarly to dropdown
and dropdown-multi
. They are reserved for Affinity-populated Fields, and
users cannot create Fields with these types.
When an array-typed value has no data in it, the API will return null
(rather than an empty
array).
To retrieve field data on companies, persons, or opportunities, call GET /v2/companies
, GET
/v2/persons
, or one of our GET */list-entries
endpoints. (Note that Opportunities only have
list-specific Fields, so all their field data will live on the */list-entries
endpoints.) For most
of these endpoints, you will need to specify the Fields for which you want data returned via the
fieldIds
or fieldTypes
parameter — Otherwise, entities will be returned without any field data
attached.
The GET /v2/companies
and /v2/persons
endpoints can return entities with enriched, global, and
relationship intelligence field data attached, but do not support list-specific field data. To get
comprehensive field data including list-specific field data on Companies and Persons, use the GET
*/list-entries
endpoints.
As mentioned above, you will need to specify the Fields (either by ID or by Type) for which you want data returned when using the following endpoints:
/v2/companies
/v2/companies/{id}
/v2/persons
/v2/persons/{id}
/v2/lists/{listId}/list-entries
Each of these endpoints has a fieldIds
parameter that accepts an array of Field IDs, and a
fieldTypes
parameter that accepts an array of Field Types. Use the GET */fields
endpoints to get
Field IDs, Field Types, and other Field-level metadata:
Call GET /v2/companies/fields
and /v2/persons/fields
to get a list of the enriched, global,
and relationship intelligence (AKA non-list-specific) Fields that exist on Companies and
Persons,
respectively. These are the Fields whose values are available to pull via GET /v2/companies
,
GET
/v2/companies/{id}
, GET /v2/persons
, and /v2/persons/{id}
.
Call GET /v2/lists/{listId}/fields
to get a list of the enriched, global, relationship
intelligence, and list-specific Fields for a given List. These are the Fields whose values
are
available to pull via GET /v2/lists/{listId}/list-entries
.
The following endpoints don't require field selection:
/v2/lists/{listId}/saved-views/{viewId}/list-entries
— See below. This endpoint returns just
the field data that has been pulled into the given Saved View via UI./v2/companies/{id}/list-entries
and GET /v2/persons/{id}/list-entries
— These endpoints
return comprehensive field data for the given person or company in the context of each List
Entry.A Saved View allows a user to configure the Fields they want to see in the UI for a given List, and
set filters and sorts on the rows on that List. A List can have multiple Saved Views. In the context
of this API, Saved Views can be useful for specifying the exact Fields for which data is needed. The
*/saved-views/{viewId}/list-entries
endpoint also respects the filters that have been set on the
given Saved View in the Affinity web app. (It does not, however, respect sorts just yet.)
This API supports pulling data from Affinity Data fields and select Dealroom fields. Due the agreements we have with some of our data partners, the API does not expose data from the following sources:
Some GET endpoints return "association" data under fields
. For example, the Persons GET endpoints
return data about which Companies a Person is associated with in Affinity. The Opportunities GET
endpoints return similar data about associated Companies and Persons. The List Entries GET endpoints
also return this data for Person and Opportunity List Entries.
The API truncates these nested arrays of Persons or Companies at 100 entries. For example, if an
Opportunity is associated with 200 Persons in Affinity, only 100 of those Persons will be returned
by the GET /opportunities
or /opportunities/{id}
endpoint.
Desired Data | Relevant Endpoints | Notes |
---|---|---|
Company/Person/Opportunity rows from a List | Grab the List’s ID from its URL in the Affinity web app, then hit GET /v2/lists/{listId}/list-entries |
Data returned will be restricted to the rows on the requested List |
Company/Person/Opportunity rows from a Saved View | In the Affinity web app, navigate to a List and create a Saved View with the desired field data and filters on it. Grab the List and Saved View IDs from the web app URL, then hit GET /v2/lists/{listId}/saved-views/{viewId}/list-entries |
Data returned will be restricted to the rows and columns on the requested Saved View |
Full rolodex of Companies or Persons in Affinity | GET /v2/companies , GET /v2/persons |
Data from list-specific Fields will not be returned |
All the rows for a given Company or Person across all Lists | GET /v2/companies/{id}/list-entries , GET /v2/persons/{id}/list-entries |
|
Metadata on Fields, including Field IDs | GET /v2/companies/fields , GET /v2/persons/fields , GET /v2/lists/{listId}/fields |
Metadata on list-specific Fields will only be returned by GET /v2/lists/{listId}/fields |
Metadata on Lists or Saved Views | GET /v2/lists , GET /v2/lists/{listId}/saved-views |
|
Opportunity data | GET /v2/opportunities will only return Opportunity names and List IDs. For comprehensive Opportunity data, hit GET /v2/lists/{listId}/list-entries for an Opportunity List |
Tip: The ID for a List, Saved View, Person, Company, or Opportunity can always be found in its Affinity web app URL.
null
as a
possible value will have it listed as one.fieldIds
parameter to return field data, now accept either
fieldIds
or fieldTypes
, and will return field data accordingly. See the
Specifying Desired Fields (Field Selection)
section
of these docs for more information. The new fieldTypes
parameter should make field data
retrieval easier for users looking to pull data from many similar Fields at a time.fieldIds
parameter to
specify which Fields they want data for. Without fieldIds
specified, these endpoints will
return
basic entity data but not field data.Returns metadata about the current user.
Get current user
required | object (Tenant) |
required | object (User) |
required | object (Grant) |
Unauthorized
Not Found
{- "grant": {
- "createdAt": "2023-01-01 00:00:00.000000000 Z",
- "scopes": [
- "api"
], - "type": "api-key"
}, - "user": {
- "firstName": "John",
- "lastName": "Smith",
- "emailAddress": "john.smith@contoso.com",
- "id": 1
}, - "tenant": {
- "name": "Contoso Ltd.",
- "subdomain": "contoso",
- "id": 1
}
}
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.
Get all Companies
Bad Request
Forbidden
{- "pagination": {
}, - "data": [
- {
- "domain": "acme.co",
- "name": "Acme",
- "isGlobal": true,
- "domains": [
- "acme.co"
], - "id": 1,
- "fields": [
- {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}, - {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}
]
}, - {
- "domain": "acme.co",
- "name": "Acme",
- "isGlobal": true,
- "domains": [
- "acme.co"
], - "id": 1,
- "fields": [
- {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}, - {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}
]
}
]
}
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.
Get a single Company
id required | integer <int64> [ 1 .. 9007199254740991 ] The company's unique identifier | ||||||||||
name required | string The company's name | ||||||||||
domain required | string or null <hostname> The company's primary domain | ||||||||||
domains required | Array of strings <hostname> All of the company's domains | ||||||||||
isGlobal required | boolean Whether or not the company is org specific | ||||||||||
Array of objects (Field) The fields associated with the company | |||||||||||
Array
|
Bad Request
Forbidden
Not Found
{- "domain": "acme.co",
- "name": "Acme",
- "isGlobal": true,
- "domains": [
- "acme.co"
], - "id": 1,
- "fields": [
- {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}, - {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}
]
}
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
required | Array of objects (FieldMetadata) A page of FieldMetadata results | ||||||||||
Array
| |||||||||||
required | object (Pagination) | ||||||||||
Bad Request
{- "pagination": {
}, - "data": [
- {
- "enrichmentSource": "affinity-data",
- "valueType": "location",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched"
}, - {
- "enrichmentSource": "affinity-data",
- "valueType": "location",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched"
}
]
}
Returns metadata for all the Lists on which the given Company appears.
Get a Company's Lists
required | Array of objects (List) A page of List results | ||||||||||
Array
| |||||||||||
required | object (Pagination) | ||||||||||
Bad Request
Not Found
{- "pagination": {
}, - "data": [
- {
- "name": "All companies",
- "creatorId": 1,
- "isPublic": false,
- "id": 1,
- "ownerId": 1
}, - {
- "name": "All companies",
- "creatorId": 1,
- "isPublic": false,
- "id": 1,
- "ownerId": 1
}
]
}
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.
Get a Company's List Entries
required | Array of objects (ListEntry) A page of ListEntry results | ||||||||||
Array
| |||||||||||
required | object (Pagination) | ||||||||||
Bad Request
Forbidden
Not Found
{- "pagination": {
}, - "data": [
- {
- "listId": 1,
- "createdAt": "2023-01-01 00:00:00.000000000 Z",
- "creatorId": 1,
- "id": 1,
- "fields": [
- {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}, - {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}
]
}, - {
- "listId": 1,
- "createdAt": "2023-01-01 00:00:00.000000000 Z",
- "creatorId": 1,
- "id": 1,
- "fields": [
- {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}, - {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}
]
}
]
}
Returns metadata on Lists.
Get metadata on all Lists
required | Array of objects (ListWithType) A page of ListWithType results | ||||||||||||
Array
| |||||||||||||
required | object (Pagination) | ||||||||||||
Bad Request
{- "pagination": {
}, - "data": [
- {
- "name": "All companies",
- "creatorId": 1,
- "isPublic": false,
- "id": 1,
- "ownerId": 1,
- "type": "company"
}, - {
- "name": "All companies",
- "creatorId": 1,
- "isPublic": false,
- "id": 1,
- "ownerId": 1,
- "type": "company"
}
]
}
Returns metadata on a single List.
Get metadata on a single List
id required | integer <int64> [ 1 .. 9007199254740991 ] The unique identifier for the list |
name required | string The name of the list |
creatorId required | integer <int64> [ 1 .. 9007199254740991 ] The ID of the user that created this list |
ownerId required | integer <int64> [ 1 .. 9007199254740991 ] The ID of the user that owns this list |
isPublic required | boolean Whether or not the list is public |
type required | string The entity type for this list |
Bad Request
Not Found
{- "name": "All companies",
- "creatorId": 1,
- "isPublic": false,
- "id": 1,
- "ownerId": 1,
- "type": "company"
}
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.
cursor | string Cursor for the next or previous page |
limit | integer <int32> [ 1 .. 100 ] Default: 100 Number of items to include in the page |
fieldIds | Array of strings <string> Field IDs for which to return field data |
fieldTypes | Array of strings <string> Field Types for which to return field data |
Get all List Entries on a List
required | Array of any or null (ListEntryWithEntity) A page of ListEntryWithEntity results | ||||||||||
Array
| |||||||||||
required | object (Pagination) | ||||||||||
Bad Request
Forbidden
Not Found
{- "pagination": {
}, - "data": [
- {
- "createdAt": "2023-01-01 00:00:00.000000000 Z",
- "creatorId": 1,
- "id": 1,
- "type": "company",
- "entity": {
- "domain": "acme.co",
- "name": "Acme",
- "isGlobal": true,
- "domains": [
- "acme.co"
], - "id": 1,
- "fields": [
- {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}, - {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}
]
}
}, - {
- "createdAt": "2023-01-01 00:00:00.000000000 Z",
- "creatorId": 1,
- "id": 1,
- "type": "company",
- "entity": {
- "domain": "acme.co",
- "name": "Acme",
- "isGlobal": true,
- "domains": [
- "acme.co"
], - "id": 1,
- "fields": [
- {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}, - {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}
]
}
}
]
}
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
required | Array of objects (FieldMetadata) A page of FieldMetadata results | ||||||||||
Array
| |||||||||||
required | object (Pagination) | ||||||||||
Bad Request
Not Found
{- "pagination": {
}, - "data": [
- {
- "enrichmentSource": "affinity-data",
- "valueType": "location",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched"
}, - {
- "enrichmentSource": "affinity-data",
- "valueType": "location",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched"
}
]
}
Returns metadata on the Saved Views on a List.
Get metadata on Saved Views
required | Array of objects (SavedView) A page of SavedView results |
required | object (Pagination) |
Bad Request
Not Found
{- "pagination": {
}, - "data": [
- {
- "createdAt": "2023-01-01 00:00:00.000000000 Z",
- "name": "my interesting companies",
- "id": 28,
- "type": "sheet"
}, - {
- "createdAt": "2023-01-01 00:00:00.000000000 Z",
- "name": "my interesting companies",
- "id": 28,
- "type": "sheet"
}
]
}
Returns metadata on a single Saved View.
Get metadata on a single Saved View
Bad Request
Not Found
{- "createdAt": "2023-01-01T00:00:00Z",
- "name": "my interesting companies",
- "id": 28,
- "type": "sheet"
}
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 for more information about Saved Views.
Requires the "Export data from Lists" permission.
Get all List Entries on a Saved View
required | Array of any or null (ListEntryWithEntity) A page of ListEntryWithEntity results | ||||||||||
Array
| |||||||||||
required | object (Pagination) | ||||||||||
Bad Request
Forbidden
Not Found
{- "pagination": {
}, - "data": [
- {
- "createdAt": "2023-01-01 00:00:00.000000000 Z",
- "creatorId": 1,
- "id": 1,
- "type": "company",
- "entity": {
- "domain": "acme.co",
- "name": "Acme",
- "isGlobal": true,
- "domains": [
- "acme.co"
], - "id": 1,
- "fields": [
- {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}, - {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}
]
}
}, - {
- "createdAt": "2023-01-01 00:00:00.000000000 Z",
- "creatorId": 1,
- "id": 1,
- "type": "company",
- "entity": {
- "domain": "acme.co",
- "name": "Acme",
- "isGlobal": true,
- "domains": [
- "acme.co"
], - "id": 1,
- "fields": [
- {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}, - {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}
]
}
}
]
}
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.
Get all Opportunities
required | Array of objects (Opportunity) A page of Opportunity results |
required | object (Pagination) |
Bad Request
Forbidden
Not Found
{- "pagination": {
}, - "data": [
- {
- "listId": 1,
- "name": "Acme Upsell $10k",
- "id": 1
}, - {
- "listId": 1,
- "name": "Acme Upsell $10k",
- "id": 1
}
]
}
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.
Get a single Opportunity
Bad Request
Forbidden
Not Found
{- "listId": 1,
- "name": "Acme Upsell $10k",
- "id": 1
}
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.
cursor | string Cursor for the next or previous page |
limit | integer <int32> [ 1 .. 100 ] Default: 100 Number of items to include in the page |
ids | Array of integers <int64> People IDs |
fieldIds | Array of strings <string> Field IDs for which to return field data |
fieldTypes | Array of strings <string> Field Types for which to return field data |
Get all Persons
required | Array of objects (Person) A page of Person results | ||||||||||||||
Array
| |||||||||||||||
required | object (Pagination) | ||||||||||||||
Bad Request
Forbidden
{- "pagination": {
}, - "data": [
- {
- "firstName": "Jane",
- "lastName": "Doe",
- "emailAddresses": [
- "jane.doe@acme.co",
- "janedoe@gmail.com"
], - "id": 1,
- "type": "internal",
- "fields": [
- {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}, - {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}
], - "primaryEmailAddress": "jane.doe@acme.co"
}, - {
- "firstName": "Jane",
- "lastName": "Doe",
- "emailAddresses": [
- "jane.doe@acme.co",
- "janedoe@gmail.com"
], - "id": 1,
- "type": "internal",
- "fields": [
- {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}, - {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}
], - "primaryEmailAddress": "jane.doe@acme.co"
}
]
}
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.
Get a single Person
id required | integer <int64> [ 1 .. 9007199254740991 ] The persons's unique identifier | ||||||||||
firstName required | string The person's first name | ||||||||||
lastName required | string or null The person's last name | ||||||||||
primaryEmailAddress required | string or null <email> The person's primary email address | ||||||||||
emailAddresses required | Array of strings <email> All of the person's email addresses | ||||||||||
type required | string The person's type | ||||||||||
Array of objects (Field) The fields associated with the person | |||||||||||
Array
|
Bad Request
Forbidden
Not Found
{- "firstName": "Jane",
- "lastName": "Doe",
- "emailAddresses": [
- "jane.doe@acme.co",
- "janedoe@gmail.com"
], - "id": 1,
- "type": "internal",
- "fields": [
- {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}, - {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}
], - "primaryEmailAddress": "jane.doe@acme.co"
}
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
required | Array of objects (FieldMetadata) A page of FieldMetadata results | ||||||||||
Array
| |||||||||||
required | object (Pagination) | ||||||||||
Bad Request
{- "pagination": {
}, - "data": [
- {
- "enrichmentSource": "affinity-data",
- "valueType": "location",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched"
}, - {
- "enrichmentSource": "affinity-data",
- "valueType": "location",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched"
}
]
}
Returns metadata for all the Lists on which the given Person appears.
Get a Person's Lists
required | Array of objects (List) A page of List results | ||||||||||
Array
| |||||||||||
required | object (Pagination) | ||||||||||
Bad Request
Not Found
{- "pagination": {
}, - "data": [
- {
- "name": "All companies",
- "creatorId": 1,
- "isPublic": false,
- "id": 1,
- "ownerId": 1
}, - {
- "name": "All companies",
- "creatorId": 1,
- "isPublic": false,
- "id": 1,
- "ownerId": 1
}
]
}
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.
Get a Person's List Entries
required | Array of objects (ListEntry) A page of ListEntry results | ||||||||||
Array
| |||||||||||
required | object (Pagination) | ||||||||||
Bad Request
Forbidden
Not Found
{- "pagination": {
}, - "data": [
- {
- "listId": 1,
- "createdAt": "2023-01-01 00:00:00.000000000 Z",
- "creatorId": 1,
- "id": 1,
- "fields": [
- {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}, - {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}
]
}, - {
- "listId": 1,
- "createdAt": "2023-01-01 00:00:00.000000000 Z",
- "creatorId": 1,
- "id": 1,
- "fields": [
- {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}, - {
- "enrichmentSource": "affinity-data",
- "name": "Location",
- "id": "affinity-data-location",
- "type": "enriched",
- "value": {
- "data": {
- "continent": "North America",
- "country": "United States",
- "streetAddress": "170 Columbus Ave",
- "city": "San Francisco",
- "state": "California"
}, - "type": "location"
}
}
]
}
]
}