---
title: "Retrieve or search status-presets"
method: POST
path: "/api/status-presets/search"
tags: ["CRUD", "StatusPresets"]
---

# Retrieve or search status-presets

`POST /api/status-presets/search`

## Request

- Base URL: `https://app.airfocus.com`
- URL: `https://app.airfocus.com/api/status-presets/search`
- Auth: HTTP bearer

Returns all status-presets or searches status-presets by query. Always returns only status-presets which are accessible by the current user.<br/>Requirements:<br/>- auth-client scopes: "team:read"

## Query parameters

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

## Request body

- StatusPresetSearchQuery

## Response `200`

- StatusPresetWithStatusPresetEmbedPage
  - `items` StatusPresetWithStatusPresetEmbed[], required
    - `_embedded` StatusPresetEmbed, required
      - `itemStatusCount` object, required
      - `itemStatusCountArchived` object, required
      - `statuses` Status[], required
        - `category` 'active' | 'closed' | 'draft', required: Status category adds some additional meaning to each status: - 'draft': only semantic meaning - 'active': only semantic meaning - 'closed': items with a status in this category will be considered as completed, which contributes to progress calculation (e.g. "1/3 items completed").
        - `color` 'blue' | 'coco' | 'daulphine' | 'great' | 'orange' | 'pink' | 'red' | 'violet' | 'yellow': Color of a status-chip in UI.
        - `default` boolean, required: Whether this status should be applied by default to newly created items. There can be only one default status in each workspace.
        - `id` string, uuid, required
        - `name` string, required: Name of this status in UI.
        - `order` integer, required: Order of this status comparing to other statuses in the same workspace.
        - `presetId` string, uuid: Id of the status preset it is part of. Empty if this status is custom for a workspace.
        - `workspaceId` string, uuid: The workspace this status belongs to. Empty for preset statuses, which are shared across workspaces
      - `workspaceIds` string[], required
    - `id` string, uuid, required
    - `name` string, required: Name of this status preset.
    - `teamId` string, uuid, required
  - `totalItems` integer, required

## Other responses

- `400`: If payload is invalid.
- `401`: If missing authentication token.
- `403`: If 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)
