Parallel AI icon

Parallel AI

Interact with Parallel AI

Actions537

List → Get List

AI-generated

Summary

Fetches rows for a specified list, with optional pagination, sorting, search, and filtering. Provide a company ID when the credentials do not identify the company to use.

Inputs

  • List ID (required) — ID of the list to fetch.
  • Company ID — Company that owns the list. Required for a personal access key; may be needed for a company API key if its user has access to multiple companies. JWT authentication uses the user's active company by default.
  • Page — Rows page to fetch; defaults to 1.
  • Page Size — Rows per page; defaults to 50, with a maximum of 100.
  • Sort Field — Column to sort by. Use dateAdded for row creation time; creation time is the default sort field.
  • Sort Order — Sort direction, asc or desc; defaults to desc.
  • Search Query — Substring to match in row values.
  • Search Field — Column to search. Use all or leave blank to search across columns.
  • Filter Model — JSON-encoded MUI DataGrid filter model. Supported operators: contains, equals, startsWith, endsWith, notEquals, isEmpty, and isNotEmpty.

Output shape

A response containing rows from the requested list.

Results are paginated using Page and Page Size. The supplied source pack contains no operation implementation body, so response fields and exact pagination envelope are not shown.

Examples

Example 1: Get a list's rows

Set List ID. Optionally set Company ID, page and page size, sorting, search, or a filter model to narrow the results.

Links

Discussion