CRUD
Items:Links

Retrieve or search item-links

Returns all item-links or searches item-links by query. Always returns only item-links which are accessible by the current user.<br/>Requirements:<br/>- auth-client scopes: "workspace:read"<br/>- user permission: "read" or higher

post/api/workspaces/{workspaceId}/links/search

Request

  • Base URL: https://app.airfocus.com
  • URL: https://app.airfocus.com/api/workspaces/{workspaceId}/links/search
  • Auth: HTTP bearer

Path parameters

workspaceIdstring uuid required

ID of the workspace which contains the managed item-links.

Query parameters

actAsAdminboolean

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

offsetinteger

How many elements to skip.

limitinteger

How many elements to return.

frominteger

From which element the page should start.

tointeger

At which element the page should end (excluding it).

Request body

includeArchivedboolean

Also include item-links which connect archived items.

itemIdsstring[]

Return only those item-links which connect the specified items.

workspaceIdsstring[]

Return only those item-links which connect items in the specified workspaces.

Response

totalItemsinteger required

Changes

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