Twenty icon

Twenty

Interact with the Twenty API

Actions25

Person → List

AI-generated

Overview

This node interacts with the Twenty API to list Person records from a Twenty workspace. It allows users to retrieve a list of people with options to filter, sort, and paginate the results. This is useful for scenarios where you need to fetch and process contact or user data from the Twenty platform, such as syncing contacts to a CRM, generating reports, or automating workflows based on person data.

Use Case Examples

  1. Fetch up to 50 people created after a specific date, sorted by creation date descending.
  2. Retrieve a list of people filtered by primary email address.
  3. Paginate through person records using cursors to handle large datasets.

Properties

Name Meaning
Base URL Base URL for your Twenty workspace REST API (include the /rest suffix, e.g. https://your-workspace.twenty.com/rest)
Limit Max number of results to return (between 1 and 200)
Order By Comma-separated list describing the sort order, e.g. ID[AscNullsFirst],createdAt[DescNullsLast]
Filter Filter string using Twenty syntax, e.g. createdAt[gte]:"2024-01-01" or emails.primaryEmail[eq]:"user@example.com"
Depth Controls whether related records are expanded in the response
Starting After Cursor to resume pagination after a given entry
Ending Before Cursor to request records ending before the given entry
Request Options Additional request options such as batching, SSL certificate validation, proxy, and timeout settings

Output

JSON

  • data - Array of person records returned by the API
  • pagination - Pagination information including cursors for navigating through pages of results

Dependencies

  • Requires an API key credential for authenticating with the Twenty API

Troubleshooting

  • Ensure the Base URL is correct and includes the /rest suffix to avoid connection errors.
  • Check that the API key credential is valid and has the necessary permissions to access person data.
  • If filtering or ordering syntax is incorrect, the API may return errors; verify the filter and orderBy strings follow Twenty API syntax.
  • Timeouts can occur if the server is slow or network issues exist; adjust the timeout setting as needed.
  • If SSL certificate validation fails and you trust the endpoint, enable the option to ignore SSL issues, but be aware of security risks.

Discussion