twprojects-list_allocations
Read-only
List scheduler allocations — who is committed to which project, and when. ALWAYS pass start_date and end_date: with neither set the endpoint returns only today through 30 days from today, and says nothing about having narrowed the range, so an unbounded call silently answers a question about a wider period with one month of data. Allocations are planned time and a separate plane from task estimates and logged time; the two are not summed. linkedTaskEstimatedTime counts each linked task whole and must not be summed across allocations.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results (1-based). | |
| fields | No | The attributes to return for each allocation, from the listed names. | |
| verbose | No | If false, returns id + name only — useful when scanning many results. | |
| end_date | No | Return allocations overlapping up to and including this day (format: YYYY-MM-DD). Defaults to 30 days from today when omitted. | |
| order_by | No | The field to sort the allocations by. Omit to keep the ordering the API applies by default. | |
| page_size | No | Number of results per page for pagination (1-500). | |
| count_only | No | If true, return only {"count": N}: the exact number of matching allocations, no rows — use for "how many". Ignores page, page_size, verbose, fields. | |
| order_mode | No | The direction to sort the results in. | |
| start_date | No | Return allocations overlapping this day onwards (format: YYYY-MM-DD). Defaults to today when omitted. | |
| project_ids | No | Only return allocations on these projects. | |
| search_term | No | A search term to filter allocations by title. | |
| show_deleted | No | Return ONLY deleted allocations instead of the active ones — this replaces the result set rather than adding to it, so a call with this set says nothing about what is currently scheduled. Deleting an allocation is a soft delete, and this is how a deleted one is found again. | |
| deleted_after | No | Only return allocations deleted at or after this moment; the boundary itself matches, unlike updated_after. Pair it with show_deleted, which is what switches the results to deleted allocations. Accepts an RFC 3339 timestamp (2026-08-03T14:30:00Z) or a plain YYYY-MM-DD date (2026-08-03), which covers that whole day in UTC. | |
| updated_after | No | Only return allocations updated strictly after this moment; the boundary itself does not match. Accepts an RFC 3339 timestamp (2026-08-03T14:30:00Z) or a plain YYYY-MM-DD date (2026-08-03), which covers that whole day in UTC. | |
| project_status | No | Only return allocations on projects with this status. | |
| project_tag_ids | No | Only return allocations on projects carrying these tags. | |
| assigned_user_ids | No | Only return allocations assigned to these users. Accepts real people and placeholder users alike. | |
| project_owner_ids | No | Only return allocations on projects owned by these users. | |
| project_company_ids | No | Only return allocations on projects belonging to these companies. | |
| project_category_ids | No | Only return allocations on projects in these categories. | |
| assigned_user_team_ids | No | Only return allocations whose assigned user belongs to one of these teams. | |
| match_all_project_tags | No | Require a project to carry every tag in project_tag_ids rather than any of them. | |
| include_financial_details | No | Include forecasted revenue and cost for the allocated time. Requires the scheduler rates entitlement and financial permission on the project; without either, the request still succeeds but the figures are withheld. Read canViewFinancialDetails on each row to tell a withheld figure from a zero one. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| meta | No | ||
| count | No | Exact number of matches across every page. Returned instead of the rows when count_only. | |
| included | No | ||
| allocations | No |