Global search

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

post/api/workspaces/global-search

Request

  • Base URL: https://app.airfocus.com
  • URL: https://app.airfocus.com/api/workspaces/global-search
  • 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.

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

archivedboolean

Search only archived or only non-archived items (only non-archived by default)

assigneeUserGroupIdsstring[]

Narrow down the search to items which are assigned to the specified user groups

assigneeUserIdsstring[]

Narrow down the search to items which are assigned to the specified users

contextQuerystring

Context-string for AI to match items by similarity

searchQuerystring

Text to search in contents of items

searchTargetsstring[]

Narrow down the search to specific targeted fields, exclusive.

statusCategoriesStatusCategory[]

Narrow down the search to items with status in the specified status-categories

workspaceIdsstring[]

Narrow down the search to specific workspaces

Response

totalItemsinteger required

Example response

{
  "items": [
    {
      "value": {
        "description": {
          "blocks": [
            {
              "content": [
                {
                  "content": "hello world",
                  "type": "text"
                }
              ],
              "type": "paragraph"
            }
          ],
          "richText": true
        },
        "fields": {
          "0fc3cfbc-27e9-3ea6-8a78-7de13dae3e3c": {
            "number": 42
          },
          "34f05b62-dd43-3e1e-82bc-b0acabd0d004": {
            "boolean": true
          },
          "5396681e-ea50-3d63-9ae3-c9f8ca17b7d8": {
            "userGroupIds": [
              "70e2b87a-b774-3022-9ef0-e55031a1c4fb"
            ],
            "userIds": [
              "24c9e15e-52af-347c-a25b-757e7bee1f9d"
            ]
          },
          "75fe57ec-4a04-3a30-8cac-5f27223df81a": {
            "dateRange": {
              "endDate": "2024-02-14",
              "startDate": "2024-01-14",
              "timezone": "UTC"
            }
          },
          "8be74552-df93-331b-bdd6-b36ed74bdb6a": {
            "selection": [
              "2bb225ce-b5ee-3493-967c-fde0d72da242"
            ]
          },
          "c7824f3d-4d5f-3b2f-a2d0-34758c1e9454": {
            "text": "A platform built for the new way of doing product management"
          },
          "c9c0d13b-a4e5-363b-a475-736cd0366142": {
            "richText": {
              "blocks": [
                {
                  "content": [
                    {
                      "content": "This is a rich text field with ",
                      "type": "text"
                    },
                    {
                      "content": [
                        {
                          "content": "bold text",
                          "type": "text"
                        }
                      ],
                      "type": "bold"
                    },
                    {
                      "content": " and ",
                      "type": "text"
                    },
                    {
                      "content": [
                        {
                          "content": "italic text",
                          "type": "text"
                        }
                      ],
                      "type": "italic"
                    },
                    {
                      "content": ".",
                      "type": "text"
                    }
                  ],
                  "type": "paragraph"
                }
              ],
              "richText": true
            }
          },
          "e34d514f-7db5-38aa-872a-7c8191a09617": {
            "date": {
              "date": "2024-01-01",
              "timezone": "UTC"
            }
          }
        }
      }
    }
  ]
}

Changes

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