v1

OpenAPI 3.0.12026-08-06274588.1 KB

Items

Query items

The returned item includes:

parentRelativeSortOrder: Only populated for child items. Used to order children within their parent's hierarchy.
relations.children: Child item IDs ordered by order within the parent's hierarchy.

get/api/v1/items

Query parameters

Completedboolean

Returns only Completed items if set to True. Default behavior - returns all items

AssignedUserIdstring uuid

Filter by assigned user

OwnerIdstring uuid

Filter by item owner (creator)

StatusIdstring uuid

Filter by status

RowIdstring uuid

Filter by row

BoardIdstring uuid

Filter by board

WorkspaceIdstring uuid

Filter by workspace

ParentIdstring uuid

Filter by parent item

CustomFieldsstring[]

Filter by custom fields joined with OR operator, exmaple: "Custom project"="Cars" Multiple custom fields: https://{TENANT_URL}/api/v1/items?workspaceId={WORKSPACE_ID}&customFields="Custom project"="Cars"&customFields="Area"="Engines"

CreatedSincestring date-time

Returns items created since specified date in UTC timezone (ISO format, in example 2024-02-05T02:00:00)

ModifiedSincestring date-time

Returns items modified since specified date UTC timezone (ISO format, in example 2024-02-05T02:00:00)

CompletedSincestring date-time

Returns items completed since specified date UTC timezone (ISO format, in example 2024-02-05T02:00:00)

Tagsstring[]

Filter by tags joined with OR operator Multiple tags: https://{TENANT_URL}/api/v1/items?workspaceId={WORKSPACE_ID}&tags=TAG1&tags=TAG2&tags=TAG3

IncludeChildItemsboolean

Skipinteger

How many records to skip

Takeinteger

How many records to take

Response

nextPageUrlstring nullable required