Attio icon

Attio

Interact with Attio API
Join our community

Actions52

Overview

This node operation "List Entries" under the "Entries" resource allows users to retrieve a filtered, sorted, and paginated list of entries from a specified list in an external system via its API. It is useful when you want to query entries (such as contacts, records, or items) within a particular list by applying filters, sorting criteria, and pagination controls.

Common scenarios:

  • Fetching all entries matching certain criteria (e.g., name equals "Ada Lovelace") from a mailing list or database.
  • Retrieving a subset of entries sorted by last name ascending.
  • Paginating through large sets of entries by specifying limits and offsets.

Practical example:
You have a contact list identified by a UUID and want to get up to 500 entries where the contact's name is "Ada Lovelace", sorted alphabetically by last name, starting from the first entry.

Properties

Name Meaning
List A UUID or slug identifying the specific list from which to retrieve entries.
Filter A JSON object used to filter the results to a subset matching given criteria. For example, filtering entries where the name equals "Ada Lovelace".
Sorts A JSON array defining how to sort the results. Each object specifies direction (asc or desc), attribute, and field to sort by. Example: sort ascending by last name.
Limit The maximum number of results to return. Defaults to 500. Controls pagination size.
Offset The number of results to skip before starting to return results. Defaults to 0. Used for pagination to skip over a number of entries.

Output

The output is an array of JSON objects representing the entries retrieved from the specified list according to the applied filters, sorts, limit, and offset.

  • Each item in the output corresponds to one entry returned by the API.
  • The structure of each entry depends on the external API's response but typically includes fields like entry ID, attributes, and metadata.
  • No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the external service.
  • The node sends HTTP POST requests to the endpoint /v2/lists/{list}/entries/query with appropriate headers including the bearer token.
  • The node expects the external API to support filtering, sorting, and pagination as per the provided JSON structures.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Common issues:

    • Invalid or expired API key causing authentication failures.
    • Incorrect UUID or slug for the list resulting in "not found" errors.
    • Malformed JSON in the Filter or Sorts properties causing request parsing errors.
    • Exceeding API rate limits or maximum allowed page size.

  • Error messages and resolutions:

    • "Operation configuration not found" — Ensure the correct operation and resource are selected.
    • Authentication errors — Verify that the API key credential is valid and has necessary permissions.
    • JSON parse errors in Filter or Sorts — Validate JSON syntax before inputting.
    • Empty or no results — Check filter criteria and pagination parameters; try removing filters to confirm data presence.

Links and References

Discussion