Items

Retrieve items from any workspace by specified IDs.

Returns an array of results, where each element is either a found item with its embeddings, or null if there no item with such ID.<br/>Requirements:<br/>- auth-client scopes: "workspace:read"<br/>- user permission: "read" or higher

post/api/workspaces/items/list

Request

  • Base URL: https://app.airfocus.com
  • URL: https://app.airfocus.com/api/workspaces/items/list
  • Auth: HTTP bearer

Query parameters

actAsAdminboolean

Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.

Request body

string[] required

Response

archivedboolean required

Whether this item is archived.

assigneeUserGroupIdsstring[] required

Ids of user groups that are assigned to this item.

assigneeUserIdsstring[] required

Ids of users who are assigned to this item.

color'amber' | 'azure' | 'black' | 'blue' | 'coco' | 'daulphine' | 'emerald' | 'fanta' | 'granite' | 'great' | 'leaf' | 'moss' | 'mutedAmber' | 'mutedAzure' | 'mutedBlack' | 'mutedBlue' | 'mutedCoco' | 'mutedDaulphine' | 'mutedEmerald' | 'mutedFanta' | 'mutedGranite' | 'mutedGreat' | 'mutedLeaf' | 'mutedMoss' | 'mutedOcean' | 'mutedOrange' | 'mutedPink' | 'mutedPurple' | 'mutedRed' | 'mutedSky' | 'mutedViolet' | 'mutedYellow' | 'ocean' | 'orange' | 'pink' | 'purple' | 'red' | 'sky' | 'violet' | 'yellow' required
createdAtstring date-time required

Timestamp of when this item was created.

fieldsobject required

Values of custom fields, where each key is a custom-field ID and each value is a JSON-formatted value of the corresponding field.

idstring uuid required

Unique identifier of this item.

lastUpdatedAtstring date-time required

Timestamp of when this item was last updated.

namestring required

Name (title) of this item.

numberinteger

A numeric id of this item, which is used to create an alias to this item like DEV-123. The number is unique within the workspace, and defined by server on item creation.

orderinteger required

A order number of this item for sorting.

statusCategoryUpdatedAtstring date-time

Timestamp of when the status of this item was last time switched from one category to another.

statusIdstring uuid required

Id of the status of this item.

statusUpdatedAtstring date-time

Timestamp of when the status of this item was last updated.

workspaceIdstring uuid required

Id of the workspace this workspace belongs to.

Changes

No recorded changes to this operation across all 1 revision of this API.