Sign in
Task

Finds tasks across every record they hang off; every task currently hangs off a change order. Narrow to one record's tasks with `relatedRecordIds`. Sorts on `title`, `sequence`, `dueDateUtc`, `completedUtc`, `complete`, `relatedRecordNumber`, `customer`, `assignedTo` or `taskGroup`; an unrecognised sort field falls back to `dueDateUtc` ascending.

post/api/tasks/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

Request body

relatedRecordIdsstring[] nullable

Only tasks hanging off these records. At most 1000 may be supplied

assignedToUserIdstring nullable

Only tasks assigned to this user

completeboolean nullable

True returns only complete tasks, false only incomplete ones; omitted returns both

customerIdstring nullable

Only tasks whose record is raised for this customer

taskGroupIdstring nullable

Only tasks filed under this group

dueFromUtcstring date-time nullable

Inclusive lower bound on dueDateUtc

dueToUtcstring date-time nullable

Inclusive upper bound on dueDateUtc

completedFromUtcstring date-time nullable

Inclusive lower bound on completedUtc

completedToUtcstring date-time nullable

Inclusive upper bound on completedUtc

overdueboolean nullable

True narrows to incomplete tasks whose due date has passed. False and omitted both apply no clause — this narrows, it does not select the complement

searchstring nullable

Case-insensitive search over the title, description, notes and the record's customer name, and an exact match on the record's number when the term reads as one

Response

The matching tasks

pageinteger required

The 1-indexed page

pageSizeinteger required

The page size

totalCountinteger required

The total count of records

totalPagesinteger required

The total pages

hasPreviousPageboolean required

True if there is a previous page

hasNextPageboolean required

True if there is a next page

Changes