---
title: "Retrieve a single field"
method: GET
path: "/api/fields/{fieldId}"
tags: ["Fields"]
---

# Retrieve a single field

`GET /api/fields/{fieldId}`

## Request

- Base URL: `https://app.airfocus.com`
- URL: `https://app.airfocus.com/api/fields/{fieldId}`
- Auth: HTTP bearer

Requirements:<br/>- auth-client scopes: "workspace:read"<br/>- user permission: "read" or higher<br/>- team features: "team-fields" when operating with team-fields

## Path parameters

- `fieldId` string, uuid, required

## Query parameters

- `actAsAdmin` boolean

## Response `200`

- union
  - BooleanFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'boolean', required
  - DateFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'date', required
  - DateRangeFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'date-range', required
  - FormSourceFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `settings` FormSourceFieldTypeSettings, required
      - `maximum` integer
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'form-source', required
  - FormTargetFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'form-target', required
  - HealthCheckInsFieldFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'health-check-ins-field', required
  - InsightsFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `settings` InsightsFieldTypeSettings, required
      - `maximum` integer
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'insights', required
  - MilestoneFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `settings` MilestoneFieldTypeSettings, required
      - `milestones` Milestone[], required: List of predefined milestones available for selection.
        - `color` 'blue' | 'coco' | 'daulphine' | 'great' | 'orange' | 'pink' | 'red' | 'violet' | 'yellow'
        - `createdAt` string, date-time, required
        - `date` string, date: Date of the milestone. It's optional, assuming that a milestone can be pre-created before the actual date is known.
        - `description` string, required: Description of the milestone.
        - `icon` 'circle' | 'diamond' | 'hexagon' | 'pentagon' | 'square' | 'triangle': Optional icon of the milestone.
        - `id` string, uuid, required: Unique identifier of the milestone.
        - `name` string, required: Name of the milestone.
        - `timezone` string: Optional timezone of the milestone date.
      - `multi` boolean, required: Indicates whether multiple milestones can be selected per item.
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'milestone', required
  - MirrorSourceFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'mirror-source', required
  - MirrorTargetFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'mirror-target', required
  - NumberFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `settings` NumberFieldTypeSettings, required
      - `maximum` number
      - `minimum` number
      - `overflow` boolean, required
      - `stepping` union
        - NumberFieldTypeSettingsSteppingEqual
          - `delta` number, required
          - `type` 'equal', required
        - NumberFieldTypeSettingsSteppingExponential
          - `factor` number, required
          - `type` 'exponential', required
        - NumberFieldTypeSettingsSteppingFibonacci
          - `type` 'fibonacci', required
      - `unit` union
        - NumberFieldTypeSettingsUnitCustom
          - `prefix` string, required
          - `suffix` string, required
          - `type` 'custom', required
        - NumberFieldTypeSettingsUnitMoney
          - `currency` string, required
          - `type` 'money', required
        - NumberFieldTypeSettingsUnitPercent
          - `type` 'percent', required
        - NumberFieldTypeSettingsUnitStoryPoints
          - `type` 'storyPoints', required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'number', required
  - OkrCheckinsFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'okr-checkins', required
  - OkrConfidenceFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `settings` OkrConfidenceFieldSettings, required
      - `low` integer, required
      - `medium` integer, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'okr-confidence', required
  - OkrKeyResultReferenceFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'okr-key-result-reference', required
  - OkrKeyResultsFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'okr-key-results', required
  - OkrProgressFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'okr-progress', required
  - OkrTimePeriodFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `settings` OkrTimePeriodFieldSettings, required
      - `timePeriods` TimePeriod[], required
        - `endDate` string, date, required
        - `id` string, uuid, required
        - `label` string, required
        - `startDate` string, date, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'okr-time-period', required
  - PeopleFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `settings` PeopleFieldTypeSettings, required
      - `autoAssign` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'people', required
  - PortalFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'portal', required
  - PortfolioSourceFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'portfolio-source', required
  - PrioritizationFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'prioritization', required
  - RichTextFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'rich-text', required
  - SelectFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `settings` SelectFieldTypeSettings, required
      - `aiSettings` AiFieldSettings
        - `prompt` string
        - `shouldAutofill` boolean, required
      - `multi` boolean, required
      - `options` SelectFieldTypeOption[], required
        - `autofillPrompt` string
        - `color` 'blue' | 'coco' | 'daulphine' | 'great' | 'orange' | 'pink' | 'red' | 'violet' | 'yellow'
        - `default` boolean, required
        - `description` string, required
        - `id` string, required
        - `name` string, required
        - `numericValue` number
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'select', required
  - TextFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `settings` TextFieldTypeSettings, required
      - `format` TextFieldTypeSettingsFormat
        - `type` 'email', required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'text', required
  - TimePeriodFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `settings` union, required
      - TimePeriodFieldSettingsIterations
        - `currentId` string, uuid, required
        - `multi` boolean, required
        - `timePeriods` TimePeriod[], required
          - `endDate` string, date, required
          - `id` string, uuid, required
          - `label` string, required
          - `startDate` string, date, required
        - `type` 'iterations', required
      - TimePeriodFieldSettingsSimple
        - `multi` boolean, required
        - `timePeriods` TimePeriod[], required
          - `endDate` string, date, required
          - `id` string, uuid, required
          - `label` string, required
          - `startDate` string, date, required
        - `type` 'simple', required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'time-period', required
  - VotesFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'votes', required
  - VotingScoreFieldWithFieldEmbed
    - `_embedded` FieldEmbed, required
      - `workspaces` FieldFieldWorkspaceEmbed[], required: List of all workspaces where this field is used.
        - `order` integer, required: Order of the field in this specific workspace.
        - `workspaceId` string, uuid, required
    - `createdAt` string, date-time, required
    - `description` string, required
    - `groupId` string, uuid
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `required` boolean, required
    - `settings` VotingAppScoreFieldTypeSettings, required
      - `maximum` number
      - `minimum` number
    - `teamFieldOrder` integer
    - `teamId` string, uuid, required
    - `typeId` 'votingScore', required

## Other responses

- `401`: If missing authentication token.
- `403`: If user does not have the required permission, or 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)