---
title: "POST /api/workspaces/global-search/partial"
method: POST
path: "/api/workspaces/global-search/partial"
tags: ["Global search"]
---

# POST /api/workspaces/global-search/partial

`POST /api/workspaces/global-search/partial`

## Request

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

Requirements:<br/>- auth-client scopes: "workspace:read"

## Query parameters

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

## Request body

- PartialGlobalSearchQuery
  - `properties` GlobalSearchItemProperty[], required: Properties to be returned. A blank set here will return only the ItemId.
    - union
      - 'alias' | 'context' | 'score'
      - string: A combination of 'fieldType:' prefix and a field type.
      - string: A combination of 'value:' prefix and a Ref.Item.Property name.
  - `query` GlobalSearchQuery, required
    - `archived` boolean: Search only archived or only non-archived items (only non-archived by default)
    - `assigneeUserGroupIds` string[]: Narrow down the search to items which are assigned to the specified user groups
    - `assigneeUserIds` string[]: Narrow down the search to items which are assigned to the specified users
    - `contextQuery` string: Context-string for AI to match items by similarity
    - `searchQuery` string: Text to search in contents of items
    - `searchTargets` string[]: Narrow down the search to specific targeted fields, exclusive.
    - `statusCategories` StatusCategory[]: Narrow down the search to items with status in the specified status-categories
    - `workspaceIds` string[]: Narrow down the search to specific workspaces

## Response `200`

- PartialGlobalSearchResultPage
  - `items` PartialGlobalSearchResult[], required
    - `alias` string
    - `context` union
      - 'archived' | 'assignees' | 'color' | 'createdAt' | 'creator' | 'description' | 'id' | 'lastUpdatedAt' | 'name' | 'number' | 'order' | 'status' | 'statusCategoryUpdatedAt' | 'statusUpdatedAt' | 'workspace'
      - string: A combination of 'fieldid:' prefix and a UUID field-id.
    - `score` number, float
    - `value` ItemPartial, required
      - `archived` boolean
      - `assigneeUserGroupIds` string[]
      - `assigneeUserIds` string[]
      - `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'
      - `createdAt` string, date-time
      - `creator` union
        - ActorAiActor
          - `actorType` union
            - 'assistant' | 'mcpServer'
            - string: An 'agent:' prefix followed by the specific agent type, e.g., 'agent:default:insights:create'
          - `id` string, uuid, required
          - `onBehalfOf` Actor, required (recursive)
          - `type` 'aiActor', required
        - ActorApp
          - `id` string, uuid, required
          - `onBehalfOf` Actor (recursive)
          - `type` 'app', required
          - `typeId` string
        - ActorIntegration
          - `id` string, uuid, required
          - `onBehalfOf` Actor (recursive)
          - `type` 'integration', required
          - `typeId` string
        - ActorShareLink
          - `type` 'shareLink', required
        - ActorSystem
          - `type` 'system', required
        - ActorUser
          - `id` string, uuid, required
          - `type` 'user', required
      - `description` RichText
        - `blocks` RichTextBlock[], required
          - union
            - RichTextBlockAttachment
              - …
            - RichTextBlockBlockquote
              - …
            - RichTextBlockCode
              - …
            - RichTextBlockCustom
              - …
            - RichTextBlockEmbed
              - …
            - RichTextBlockHeadline
              - …
            - RichTextBlockIndentation
              - …
            - RichTextBlockList
              - …
            - RichTextBlockPanel
              - …
            - RichTextBlockParagraph
              - …
      - `fields` object
      - `id` string, uuid, required
      - `lastUpdatedAt` string, date-time
      - `name` string
      - `number` integer
      - `order` integer
      - `statusCategoryUpdatedAt` string, date-time
      - `statusId` string, uuid
      - `statusUpdatedAt` string, date-time
      - `workspaceId` string, uuid
  - `totalItems` integer, required

## Other responses

- `401`: If missing authentication token.
- `403`: If authenticated client does not have the required access scopes.

---

[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)