Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Task → Get Task Assignments

AI-generated

Summary

Retrieves the task assignments belonging to a given Rentman task via GET /tasks/{taskId}/taskassignments, with optional pagination, filtering, sorting, field selection and link expansion.

Inputs

  • taskId (required) — ID of the parent task whose assignments are fetched.
  • returnAll — If true, follows next_page_url to fetch all pages; otherwise only up to Limit results are returned.
  • limit — Max number of results (default 50, min 1). Shown only when Return All is off.
  • offset — Number of results to skip (default 0). Shown only when Return All is off.
  • filters — Optional collection: Created After, Modified After, Modified Before, ID Greater Than (useful for incremental sync), Fields (comma-separated field list), Sort (e.g. +id or -modified).
  • expand — Comma-separated linkable fields to inline instead of returning paths; supports dot notation up to 3 levels (e.g. equipment,equipment.creator).
  • requestOptions — Node-level settings: batching (items per batch, interval), ignore SSL issues, proxy, timeout (default 10000 ms).

Output shape

A list of task assignment records for the specified task, as returned by the Rentman API.

Linked fields appear as paths unless expanded via Expand. Fields filter limits returned properties. With Return All off, only the Limit/Offset window is returned.

Examples

Example 1: Fetch every assignment for a task

Task ID = 123, Return All = true

Example 2: Incremental sync of recently changed assignments

Task ID = 123, Return All = true, Filters: Modified After = last run date, Sort = +id

Example 3: Get assignments with linked records inlined

Task ID = 123, Limit = 20, Expand = equipment,equipment.creator

Links

Discussion