Productive icon

Productive

Interact with the Productive API

Actions508

Bookings → Get bookings

AI-generated

Summary

Retrieve a list of bookings from the Productive API with optional pagination, sorting, and filtering.

Inputs

  • Return All — Boolean to return all bookings or limit the results.
  • Limit — Maximum number of bookings to return when not returning all.
  • Page Number — Page number to retrieve when paging through results.
  • Page Size — Number of bookings per page (between 1 and 200).
  • Filter Query String — Literal API filter query string that overrides other filters.
  • Filters — One or more filters by fields such as approval status, booking type, project ID, status, tags, etc. Ignored if Filter Query String is set.
  • Sort By — Field to sort the bookings by (e.g., ID, Started On, Last Activity At, Draft, or None).
  • Sort Order — Sort direction: ascending or descending.

Output shape

a list of booking records

Returns bookings that match the specified filtering criteria. Supports pagination when 'Return All' is false. If 'Return All' is true, all matching bookings are returned regardless of limit or pagination settings.

Examples

Example 1: Get first page of 30 bookings sorted by start date ascending, filtered by approval status equals 'approved'.

set Return All to false, Limit to 30, Page Number to 1, add filter with field 'Approval Status', operation 'Equals', value 'approved', Sort By 'Started On', Sort Order 'Ascending'.

Discussion