List records with the Attio API

Lists 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.

Identifier
attio_list_records

The request

POST https://connect.reportei.com/api/tools/attio_list_records/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "object": "<object>"
  }
}

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

ParameterTypeRequiredDescription
objectstringYesapi_slug of the object from List objects, such as people, companies or deals.
filterobjectNoFilter keyed by attribute slug, in shorthand like {name: Acme} or verbose with operators such as $eq, $contains, $in, $not_empty, $and and $or. A person name is matched on name.full_name and an email on email_addresses.email_address.
sortsarrayNoSort order, first item first.
limitintegerNoRecords per page. The default is 500.
offsetintegerNoRecords 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_records. It becomes your agent's tool definition with no conversion.

Other Attio tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.