List entries with the Attio API
Lists the entries of a list, with an optional filter and sorts on the list attributes, such as the stage of a pipeline. Each entry has id.entry_id, parent_record_id and parent_object. Paginate with limit, 500 by default, and offset.
- Identifier
- attio_list_entries
The request
POST https://connect.reportei.com/api/tools/attio_list_entries/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"list": "<list>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| list | string | Yes | api_slug of the list from List lists. |
| filter | object | No | Filter keyed by list attribute slug, in shorthand like {stage: Won} or verbose with operators such as $eq, $contains, $in, $and and $or. |
| sorts | array | No | Sort order, first item first. |
| limit | integer | No | Entries per page. The default is 500. |
| offset | integer | No | Entries to skip, for the next page. |
Supported connections
Your customer connects their Attio account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/attio, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/attio_list_entries. It becomes your agent's tool definition with no conversion.
Other Attio tools
- List objectsGETLists the objects of the workspace: the standard ones, such as people, companies and deals, and the custom ones. Use the api_slug of an item as object in the record tools and as parent_object in the entry and note tools.
- List attributesGETLists the attributes of an object or of a list, in the order of the app, with the api_slug, the type and whether each one is required or unique. The slugs are the keys of values and entry_values in the other tools and of their filters.
- List recordsPOSTLists the records of an object, with an optional filter and sorts. Each record comes with id.record_id and its values keyed by attribute slug. Paginate with limit, 500 by default, and offset.
- Get recordGETReturns one record with all its values keyed by attribute slug and its web_url.
- Create recordPOSTCreates a record of an object, such as a person, a company or a deal. Fails when a unique attribute, such as a company domain or a person email, already belongs to another record. Returns the new record with id.record_id.
- Update recordPATCHUpdates the given attributes of a record and leaves the others unchanged. Values of a multiselect attribute are added to the ones it already has.
- List listsGETLists the lists of the workspace, such as sales pipelines, in the order of the sidebar. Use the api_slug of an item as list in the entry tools; its parent_object says which object its records come from.
- Create list entryPOSTAdds a record to a list as a new entry, with values for the list attributes, such as the stage. The same record can be added more than once. Returns the entry with id.entry_id.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
