Affinity logo

lists

Operations about lists

Get metadata on all Lists

Paginate through all Lists in your organization that you have access to view. Returns basic information about each List, including name, owner, and privacy settings.

SecuritybearerAuth
Request
query Parameters
cursor
string

Cursor for the next or previous page

Example: cursor=ICAgICAgYmVmb3JlOjo6Nw
limit
integer <int32> [ 1 .. 100 ]
Default: 100

Number of items to include in the page

Example: limit=100
Responses
200

OK

Response Headers
X-Ratelimit-Limit-User
integer

Number of requests allowed per minute for the user

X-Ratelimit-Limit-User-Remaining
integer

Number of requests remaining for the user

X-Ratelimit-Limit-User-Reset
integer

Time in seconds before the limit resets for the user

X-Ratelimit-Limit-Org
integer

Number of requests allowed per month for the account

X-Ratelimit-Limit-Org-Remaining
integer

Number of requests remaining for the account

X-Ratelimit-Limit-Org-Reset
integer

Time in seconds before the limit resets for the account

Response Schema: application/json
required
Array of objects (ListWithType) <= 100 items

A page of ListWithType results

Array (<= 100 items)
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

Enum: "company" "opportunity" "person"
required
object (Pagination)
prevUrl
string or null <uri>

URL for the previous page

nextUrl
string or null <uri>

URL for the next page

400

Bad Request

default

Errors

get/v2/lists
Request samples 
Response samples 
application/json
{}
Get metadata on a single List
Retrieve detailed information about a specific List you have access to view.
Returns List configuration including name, owner, privacy settings, and creation details.


SecuritybearerAuth 
Request 
path Parameters
listId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List ID


 
Responses 
200
OK


 Response Headers 
X-Ratelimit-Limit-User
integer
Number of requests allowed per minute for the user


 
X-Ratelimit-Limit-User-Remaining
integer
Number of requests remaining for the user


 
X-Ratelimit-Limit-User-Reset
integer
Time in seconds before the limit resets for the user


 
X-Ratelimit-Limit-Org
integer
Number of requests allowed per month for the account


 
X-Ratelimit-Limit-Org-Remaining
integer
Number of requests remaining for the account


 
X-Ratelimit-Limit-Org-Reset
integer
Time in seconds before the limit resets for the account


 
Response Schema: application/json
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


 Enum: "company" "opportunity" "person"  
400
Bad Request


404
Not Found


default
Errors


get/v2/lists/{listId}
Request samples 
Response samples 
application/json
Example Company list.


{
  • "id": 1,
  • "name": "My Companies",
  • "type": "company",
  • "isPublic": false,
  • "ownerId": 1,
  • "creatorId": 1
}
Get metadata on a single List's Fields
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.


SecuritybearerAuth 
Request 
path Parameters
listId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List ID


 
query Parameters
cursor
string
Cursor for the next or previous page


 
 Example:  cursor=ICAgICAgYmVmb3JlOjo6Nw
limit
integer <int32>   [ 1 .. 100 ] 
 Default:  100
Number of items to include in the page


 
 Example:  limit=100
Responses 
200
OK


 Response Headers 
X-Ratelimit-Limit-User
integer
Number of requests allowed per minute for the user


 
X-Ratelimit-Limit-User-Remaining
integer
Number of requests remaining for the user


 
X-Ratelimit-Limit-User-Reset
integer
Time in seconds before the limit resets for the user


 
X-Ratelimit-Limit-Org
integer
Number of requests allowed per month for the account


 
X-Ratelimit-Limit-Org-Remaining
integer
Number of requests remaining for the account


 
X-Ratelimit-Limit-Org-Reset
integer
Time in seconds before the limit resets for the account


 
Response Schema: application/json
required
Array of objects (FieldMetadata)   <= 100 items 
A page of FieldMetadata results


 
 Array (<= 100 items)
id
required
string
The field's unique identifier


 
name
required
string
The field's name


 
type
required
string
The field's type


 Enum: "enriched" "global" "list" "relationship-intelligence"  
enrichmentSource
required
string or null
The source of the data in this Field (if it is enriched)


 Enum: "affinity-data" "dealroom" "eventbrite" "mailchimp" null  
valueType
required
string
The type of the data in this Field


 Enum: "person" "person-multi" "company" "company-multi" "filterable-text" "filterable-text-multi" "number" "number-multi" "datetime" "location" "location-multi" "text" "ranked-dropdown" "dropdown" "dropdown-multi" "formula-number" "interaction"  
required
object (Pagination) 
 
prevUrl
string or null <uri> 
URL for the previous page


 
nextUrl
string or null <uri> 
URL for the next page


 
400
Bad Request


404
Not Found


default
Errors


get/v2/lists/{listId}/fields
Request samples 
Response samples 
application/json
Example response on a Company list.


{
  • "data": [
    ],
  • "pagination": {}
}
Get all List Entries on a 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.


SecuritybearerAuth 
Request 
path Parameters
listId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List ID


 
query Parameters
cursor
string
Cursor for the next or previous page


 
 Example:  cursor=ICAgICAgYmVmb3JlOjo6Nw
limit
integer <int32>   [ 1 .. 100 ] 
 Default:  100
Number of items to include in the page


 
 Example:  limit=100
fieldIds
Array of strings
Field IDs for which to return field data


 
 Example:  fieldIds=field-1&fieldIds=field-2
fieldTypes
Array of strings
Field Types for which to return field data


Items Enum: "enriched" "global" "list" "relationship-intelligence"  
 Example:  fieldTypes=enriched&fieldTypes=global
Responses 
200
OK


 Response Headers 
X-Ratelimit-Limit-User
integer
Number of requests allowed per minute for the user


 
X-Ratelimit-Limit-User-Remaining
integer
Number of requests remaining for the user


 
X-Ratelimit-Limit-User-Reset
integer
Time in seconds before the limit resets for the user


 
X-Ratelimit-Limit-Org
integer
Number of requests allowed per month for the account


 
X-Ratelimit-Limit-Org-Remaining
integer
Number of requests remaining for the account


 
X-Ratelimit-Limit-Org-Reset
integer
Time in seconds before the limit resets for the account


 
Response Schema: application/json
required
Array of any or null (ListEntryWithEntity)   <= 100 items 
A page of ListEntryWithEntity results


 
 Array (<= 100 items)
id
required
integer <int64>   [ 1 .. 9007199254740991 ] 
The list entry's unique identifier


 
type
required
string
The entity type for this list entry


 
 Value:  "company"
listId
required
integer <int64>   [ 1 .. 9007199254740991 ] 
The ID of the list that this list entry belongs to


 
createdAt
required
string <date-time> 
The date that the list entry was created


 
creatorId
required
integer or null <int64>   [ 1 .. 9007199254740991 ] 
The ID of the user that created this list entry


 
required
object (Company) 
Company model


 
required
object (Pagination) 
 
prevUrl
string or null <uri> 
URL for the previous page


 
nextUrl
string or null <uri> 
URL for the next page


 
400
Bad Request


403
Forbidden


404
Not Found


default
Errors


get/v2/lists/{listId}/list-entries
Request samples 
Response samples 
application/json
Example response on a Company list using fieldTypes=enriched.


{
  • "data": [
    ],
  • "pagination": {}
}
Get a single List Entry on a List
Retrieve a single list entry.
Returns basic information and field data, including list-specific field data.


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, the List Entry 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.


SecuritybearerAuth 
Request 
path Parameters
listId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List ID


 
listEntryId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List Entry ID


 
query Parameters
fieldIds
Array of strings
Field IDs for which to return field data


 
 Example:  fieldIds=field-1&fieldIds=field-2
fieldTypes
Array of strings
Field Types for which to return field data


Items Enum: "enriched" "global" "list" "relationship-intelligence"  
 Example:  fieldTypes=enriched&fieldTypes=global
Responses 
200
OK


 Response Headers 
X-Ratelimit-Limit-User
integer
Number of requests allowed per minute for the user


 
X-Ratelimit-Limit-User-Remaining
integer
Number of requests remaining for the user


 
X-Ratelimit-Limit-User-Reset
integer
Time in seconds before the limit resets for the user


 
X-Ratelimit-Limit-Org
integer
Number of requests allowed per month for the account


 
X-Ratelimit-Limit-Org-Remaining
integer
Number of requests remaining for the account


 
X-Ratelimit-Limit-Org-Reset
integer
Time in seconds before the limit resets for the account


 
Response Schema: application/json
id
required
integer <int64>   [ 1 .. 9007199254740991 ] 
The list entry's unique identifier


 
type
required
string
The entity type for this list entry


 
 Value:  "company"
listId
required
integer <int64>   [ 1 .. 9007199254740991 ] 
The ID of the list that this list entry belongs to


 
createdAt
required
string <date-time> 
The date that the list entry was created


 
creatorId
required
integer or null <int64>   [ 1 .. 9007199254740991 ] 
The ID of the user that created this list entry


 
required
object (Company) 
Company model


 
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 tenant specific


 
Array of objects (Field) 
The fields associated with the company


 
400
Bad Request


403
Forbidden


404
Not Found


default
Errors


get/v2/lists/{listId}/list-entries/{listEntryId}
Request samples 
Response samples 
application/json
Example response on a Company list using fieldTypes=enriched.


{
  • "id": 1,
  • "type": "company",
  • "listId": 1,
  • "entity": {
    },
  • "creatorId": 1,
  • "createdAt": "2023-01-01T00:00:00Z"
}
Get field values on a single List Entry
Paginate through all field values on a single list entry.


All fields will be included by default. The ids and types parameters can be used to filter the collection.


Requires the "Export data from Lists" permission.


SecuritybearerAuth 
Request 
path Parameters
listId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List ID


 
listEntryId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List Entry ID


 
query Parameters
ids
Array of strings
Field IDs for which to return field data


 
 Example:  ids=field-1&ids=field-2
types
Array of strings
Field Types for which to return field data


Items Enum: "enriched" "global" "list" "relationship-intelligence"  
 Example:  types=enriched&types=global
cursor
string
Cursor for the next or previous page


 
 Example:  cursor=ICAgICAgYmVmb3JlOjo6Nw
limit
integer <int32>   [ 1 .. 100 ] 
 Default:  20
Number of items to include in the page


 
 Example:  limit=20
Responses 
200
OK


 Response Headers 
X-Ratelimit-Limit-User
integer
Number of requests allowed per minute for the user


 
X-Ratelimit-Limit-User-Remaining
integer
Number of requests remaining for the user


 
X-Ratelimit-Limit-User-Reset
integer
Time in seconds before the limit resets for the user


 
X-Ratelimit-Limit-Org
integer
Number of requests allowed per month for the account


 
X-Ratelimit-Limit-Org-Remaining
integer
Number of requests remaining for the account


 
X-Ratelimit-Limit-Org-Reset
integer
Time in seconds before the limit resets for the account


 
Response Schema: application/json
required
Array of objects (Field)   <= 100 items 
A page of Field results


 
 Array (<= 100 items)
id
required
string
The field's unique identifier


 
name
required
string
The field's name


 
type
required
string
The field's type


 Enum: "enriched" "global" "list" "relationship-intelligence"  
enrichmentSource
required
string or null
The source of the data in this Field (if it is enriched)


 Enum: "affinity-data" "dealroom" "eventbrite" "mailchimp" null  
required
FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) (FieldValue) 
 
required
object (Pagination) 
 
prevUrl
string or null <uri> 
URL for the previous page


 
nextUrl
string or null <uri> 
URL for the next page


 
400
Bad Request


403
Forbidden


404
Not Found


default
Errors


get/v2/lists/{listId}/list-entries/{listEntryId}/fields
Request samples 
Response samples 
application/json
Example response on a Company list using types=enriched.


{
  • "data": [
    ],
  • "pagination": {}
}
Perform batch operations on a list entry's fields
Perform batch operations on a list entry's fields.


Currently the only operation at the endpoint is update-fields, which allows you to update multiple field values with a single request. This is equivalent to calling the single field update endpoint multiple times.    


Requires the "Export data from Lists" permission.


SecuritybearerAuth 
Request 
path Parameters
listId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List ID


 
listEntryId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List Entry ID


 
Request Body schema: application/json
required
operation
required
string
 
 Value:  "update-fields"
required
Array of objects  <= 100 items 
 
 Array (<= 100 items)
id
required
string
The field's unique identifier.


 
FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) (FieldValueUpdate) 
 
Responses 
200
OK


 Response Headers 
X-Ratelimit-Limit-User
integer
Number of requests allowed per minute for the user


 
X-Ratelimit-Limit-User-Remaining
integer
Number of requests remaining for the user


 
X-Ratelimit-Limit-User-Reset
integer
Time in seconds before the limit resets for the user


 
X-Ratelimit-Limit-Org
integer
Number of requests allowed per month for the account


 
X-Ratelimit-Limit-Org-Remaining
integer
Number of requests remaining for the account


 
X-Ratelimit-Limit-Org-Reset
integer
Time in seconds before the limit resets for the account


 
Response Schema: application/json
operation
string (ListEntryBatchOperations) 
 Value: "update-fields"  
400
Bad Request


403
Forbidden


404
Not Found


default
Errors


patch/v2/lists/{listId}/list-entries/{listEntryId}/fields
Request samples 
application/json
Example request for an update-fields operation.


{
  • "operation": "update-fields",
  • "updates": [
    ]
}
Response samples 
application/json
Example response from an update-fields operation.


{
  • "operation": "update-fields"
}
Get a single field value
Returns a single field value on a list entry.


Requires the "Export data from Lists" permission.


SecuritybearerAuth 
Request 
path Parameters
listId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List ID


 
listEntryId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List Entry ID


 
fieldId
required
string
Field ID


 
 Example:  field-1234
Responses 
200
OK


 Response Headers 
X-Ratelimit-Limit-User
integer
Number of requests allowed per minute for the user


 
X-Ratelimit-Limit-User-Remaining
integer
Number of requests remaining for the user


 
X-Ratelimit-Limit-User-Reset
integer
Time in seconds before the limit resets for the user


 
X-Ratelimit-Limit-Org
integer
Number of requests allowed per month for the account


 
X-Ratelimit-Limit-Org-Remaining
integer
Number of requests remaining for the account


 
X-Ratelimit-Limit-Org-Reset
integer
Time in seconds before the limit resets for the account


 
Response Schema: application/json
id
required
string
The field's unique identifier


 
name
required
string
The field's name


 
type
required
string
The field's type


 Enum: "enriched" "global" "list" "relationship-intelligence"  
enrichmentSource
required
string or null
The source of the data in this Field (if it is enriched)


 Enum: "affinity-data" "dealroom" "eventbrite" "mailchimp" null  
required
FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) or FieldValue (object) (FieldValue) 
 
One of:
type
required
string
The type of value


 
 Value:  "company-multi"
required
Array of objects or null (CompanyData)   <= 100 items 
The values for many companies


 
400
Bad Request


403
Forbidden


404
Not Found


default
Errors


get/v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}
Request samples 
Response samples 
application/json
Example response on a field with a company value.


{
  • "id": "field-1",
  • "name": "Field with company value",
  • "type": "list",
  • "enrichmentSource": null,
  • "value": {
    }
}
Update a single field value on a List Entry
Update a single field value.


Requires the "Export data from Lists" permission.


SecuritybearerAuth 
Request 
path Parameters
listId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List ID


 
listEntryId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List Entry ID


 
fieldId
required
string
Field ID


 
Request Body schema: application/json
required
FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) or FieldValueUpdate (object) (FieldValueUpdate) 
 
One of:
type
required
string
The type of value


 
 Value:  "company-multi"
required
Array of objects or null (CompanyReference)   <= 100 items 
The values for many companies


 
Responses 
204
No Content


400
Bad Request


403
Forbidden


404
Not Found


default
Errors


post/v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}
Request samples 
application/json
Example response on a field with a company value.


{
  • "value": {
    }
}
Response samples 
application/json
{
  • "errors": [
    ]
}
Get metadata on Saved Views
Paginate through all Saved Views you have access to view for a specific List.
Returns Saved View configurations including name, column settings, and owner information.


SecuritybearerAuth 
Request 
path Parameters
listId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List ID


 
query Parameters
cursor
string
Cursor for the next or previous page


 
 Example:  cursor=ICAgICAgYmVmb3JlOjo6Nw
limit
integer <int32>   [ 1 .. 100 ] 
 Default:  100
Number of items to include in the page


 
 Example:  limit=100
Responses 
200
OK


 Response Headers 
X-Ratelimit-Limit-User
integer
Number of requests allowed per minute for the user


 
X-Ratelimit-Limit-User-Remaining
integer
Number of requests remaining for the user


 
X-Ratelimit-Limit-User-Reset
integer
Time in seconds before the limit resets for the user


 
X-Ratelimit-Limit-Org
integer
Number of requests allowed per month for the account


 
X-Ratelimit-Limit-Org-Remaining
integer
Number of requests remaining for the account


 
X-Ratelimit-Limit-Org-Reset
integer
Time in seconds before the limit resets for the account


 
Response Schema: application/json
required
Array of objects (SavedView)   <= 100 items 
A page of SavedView results


 
 Array (<= 100 items)
id
required
integer <int64>   [ 1 .. 9007199254740991 ] 
The saved view's unique identifier


 
name
required
string
The saved view's name


 
type
required
string
The type for this saved view


 Enum: "sheet" "board" "dashboard"  
createdAt
required
string <date-time> 
The date that the saved view was created


 
required
object (Pagination) 
 
prevUrl
string or null <uri> 
URL for the previous page


 
nextUrl
string or null <uri> 
URL for the next page


 
400
Bad Request


404
Not Found


default
Errors


get/v2/lists/{listId}/saved-views
Request samples 
Response samples 
application/json
{}
Get metadata on a single Saved View
Retrieve detailed information about a specific Saved View you have access to view.
Returns complete Saved View configuration including name, sorting, and column visibility settings.


SecuritybearerAuth 
Request 
path Parameters
listId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List ID


 
viewId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
Saved view ID


 
Responses 
200
OK


 Response Headers 
X-Ratelimit-Limit-User
integer
Number of requests allowed per minute for the user


 
X-Ratelimit-Limit-User-Remaining
integer
Number of requests remaining for the user


 
X-Ratelimit-Limit-User-Reset
integer
Time in seconds before the limit resets for the user


 
X-Ratelimit-Limit-Org
integer
Number of requests allowed per month for the account


 
X-Ratelimit-Limit-Org-Remaining
integer
Number of requests remaining for the account


 
X-Ratelimit-Limit-Org-Reset
integer
Time in seconds before the limit resets for the account


 
Response Schema: application/json
id
required
integer <int64>   [ 1 .. 9007199254740991 ] 
The saved view's unique identifier


 
name
required
string
The saved view's name


 
type
required
string
The type for this saved view


 Enum: "sheet" "board" "dashboard"  
createdAt
required
string <date-time> 
The date that the saved view was created


 
400
Bad Request


404
Not Found


default
Errors


get/v2/lists/{listId}/saved-views/{viewId}
Request samples 
Response samples 
application/json
{
  • "createdAt": "2023-06-15T00:00:00Z",
  • "name": "Deal Pipeline Status",
  • "id": 42,
  • "type": "board"
}
Get all List Entries on a 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 for more information about Saved Views.


Requires the "Export data from Lists" permission.


SecuritybearerAuth 
Request 
path Parameters
listId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
List ID


 
viewId
required
integer <int64>   [ 1 .. 9223372036854776000 ] 
Saved view ID


 
query Parameters
cursor
string
Cursor for the next or previous page


 
 Example:  cursor=ICAgICAgYmVmb3JlOjo6Nw
limit
integer <int32>   [ 1 .. 100 ] 
 Default:  100
Number of items to include in the page


 
 Example:  limit=100
Responses 
200
OK


 Response Headers 
X-Ratelimit-Limit-User
integer
Number of requests allowed per minute for the user


 
X-Ratelimit-Limit-User-Remaining
integer
Number of requests remaining for the user


 
X-Ratelimit-Limit-User-Reset
integer
Time in seconds before the limit resets for the user


 
X-Ratelimit-Limit-Org
integer
Number of requests allowed per month for the account


 
X-Ratelimit-Limit-Org-Remaining
integer
Number of requests remaining for the account


 
X-Ratelimit-Limit-Org-Reset
integer
Time in seconds before the limit resets for the account


 
Response Schema: application/json
required
Array of any or null (ListEntryWithEntity)   <= 100 items 
A page of ListEntryWithEntity results


 
 Array (<= 100 items)
id
required
integer <int64>   [ 1 .. 9007199254740991 ] 
The list entry's unique identifier


 
type
required
string
The entity type for this list entry


 
 Value:  "company"
listId
required
integer <int64>   [ 1 .. 9007199254740991 ] 
The ID of the list that this list entry belongs to


 
createdAt
required
string <date-time> 
The date that the list entry was created


 
creatorId
required
integer or null <int64>   [ 1 .. 9007199254740991 ] 
The ID of the user that created this list entry


 
required
object (Company) 
Company model


 
required
object (Pagination) 
 
prevUrl
string or null <uri> 
URL for the previous page


 
nextUrl
string or null <uri> 
URL for the next page


 
400
Bad Request


403
Forbidden


404
Not Found


default
Errors


get/v2/lists/{listId}/saved-views/{viewId}/list-entries
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {}
}
➔ Next to meetings