Productive icon

Productive

Interact with the Productive API

Actions508

Contact Entries → Get contact entries

AI-generated

Summary

Retrieve multiple contact entries from the Productive system with optional filtering and pagination.

Inputs

  • Return All — Set to true to return all contact entries; if false, results are paginated.
  • Limit — Maximum number of contact entries to return when not returning all (default 50).
  • Page Number — Page number to retrieve when pagination is used (default 1).
  • Page Size — Number of contact entries per page (default 30, maximum 200).
  • Filter Query String — A raw filter query string overriding other filters; allows specifying one or more filters in Productive API syntax.
  • Filters — A collection of filter conditions specifying field, operation (such as equals or contains), and value to filter contact entries by; ignored if Filter Query String is set. Supported fields include Company ID, Contactable ID, Contactable Type, Invoice ID, Person ID, Subsidiary ID.

Output shape

An array of contact entry records matching the filter criteria and pagination settings.

When 'Return All' is true, all matching contact entries are returned without pagination. When false, pagination applies using 'Page Number' and 'Page Size'. If 'Filter Query String' is provided, it overrides all individual filters. Errors during execution can be handled according to the node's 'Continue On Fail' setting.

Examples

Example 1: Retrieve all contact entries for a specific company

Set Return All to true and add a filter for 'Company ID' equals the target company's ID.

Example 2: Get the second page of contact entries, 50 per page, filtered to entries where Contactable Type contains 'Person'

Set Return All to false, Page Number to 2, Page Size to 50, and add a filter with Contactable Type 'contains' 'Person'.

Discussion