Productive icon

Productive

Interact with the Productive API

Actions508

Document Types → Get document_types

AI-generated

Summary

Retrieve document type records from the Productive API, applying optional filtering and pagination.

Inputs

  • Filter Query String — A literal filter query string that overrides all other filters if provided (e.g., filter[field_name]=value). Multiple filters must follow the Productive API syntax.
  • Filters — One or more field-based filters to apply if no filter query string is specified. Available fields are Exportable Type ID, Status, and Subsidiary ID, each supporting operations like equals, contains, greater than, and others.
  • Return All (required) — Boolean flag to determine whether to return all matching document types or limit the results.
  • Limit — Maximum number of results to return when 'Return All' is false.
  • Page Number — Page number to retrieve when limiting results (default is 1).
  • Page Size — Number of document types to return per page when limiting (default 30, max 200).

Output shape

a list of document type records

Supports pagination when 'Return All' is false; returns all matched records otherwise. Filtering uses the Productive API syntax and supports filtering by specified fields or a custom query string override.

Examples

Example 1: Retrieve all document types without filters

Set 'Return All' to true, no filters or query string.

Example 2: Retrieve first page of document types with a maximum of 20 entries, filtered by Status equals 'active'

Set 'Return All' to false, 'Limit' to 20, and add a filter with field 'Status', operation 'Equals', value 'active'.

Discussion