---
title: "Retrieve or search item-relations"
method: POST
path: "/api/workspaces/item-relations/search"
tags: ["CRUD", "Items:Relations"]
---

# Retrieve or search item-relations

`POST /api/workspaces/item-relations/search`

## Request

- Base URL: `https://app.airfocus.com`
- URL: `https://app.airfocus.com/api/workspaces/item-relations/search`
- Auth: HTTP bearer

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

## Query parameters

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

## Request body

- ItemRelationSearchQuery
  - `filter` union
    - ItemRelationSearchQueryFilterChild
      - `itemId` string, uuid, required
      - `type` 'child', required
    - ItemRelationSearchQueryFilterParent
      - `itemId` string, uuid, required
      - `type` 'parent', required
    - ItemRelationSearchQueryFilterParentOrChild
      - `itemId` string, uuid, required
      - `type` 'parentOrChild', required

## Response `200`

- ItemRelationWithItemRelationEmbedPage
  - `items` ItemRelationWithItemRelationEmbed[], required
    - `_embedded` ItemRelationEmbed, required
      - `constraints` ItemRelationConstraint[], required
        - `extensionId` string, uuid, required
        - `type` 'readonly', required
    - `childId` string, uuid, required
    - `childOrder` integer, required
    - `id` string, uuid, required
    - `parentId` string, uuid, required
    - `parentOrder` integer, 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)