---
title: "Retrieve or search item-links"
method: POST
path: "/api/workspaces/{workspaceId}/links/search"
tags: ["CRUD", "Items:Links"]
---

# Retrieve or search item-links

`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

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

## Path parameters

- `workspaceId` string, uuid, required

## Query parameters

- `actAsAdmin` boolean
- `offset` integer
- `limit` integer
- `from` integer
- `to` integer

## Request body

- ItemLinkSearchQuery: Query-parameters for searching item-links.
  - `includeArchived` boolean: Also include item-links which connect archived items.
  - `itemIds` string[]: Return only those item-links which connect the specified items.
  - `workspaceIds` string[]: Return only those item-links which connect items in the specified workspaces.

## Response `200`

- ItemLinkWithItemLinkEmbedPage
  - `items` ItemLinkWithItemLinkEmbed[], required
    - `_embedded` ItemLinkEmbed, required
      - `apps` object, required
      - `constraints` ItemLinkConstraint[], required
        - union
          - ItemLinkConstraintReadonly
            - `extensionId` string, uuid, required
            - `type` 'readonly', required
          - ItemLinkConstraintUndeletable
            - `extensionId` string, uuid, required
            - `type` 'undeletable', required
      - `fromWorkspaceId` string, uuid, required
      - `toWorkspaceId` string, uuid, required
    - `fromItemId` string, uuid, required
    - `fromOrder` integer, required: How this item-link is ordered in the list of links of the "fromItem".
    - `id` string, uuid, required
    - `toItemId` string, uuid, required
    - `toOrder` integer, required: How this item-link is ordered in the list of links of the "toItem".
    - `typeId` string, uuid, required
  - `totalItems` integer, required

## Other responses

- `400`: If payload is invalid.
- `401`: If missing authentication token.
- `403`: If user does not have the required permission, or authenticated client does not have the required access scopes.
- `default`: If any other error happens.

---

[API](https://skmtc.dev/airfocus/apis/airfocus-api.md) · [All operations](https://skmtc.dev/airfocus/apis/airfocus-api/llms.txt) · [OpenAPI document](https://skmtc.dev/airfocus/apis/airfocus-api/revisions/fc9ccaa2ec6d?raw)