Fields

Search fields

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

post/api/fields/search

Request

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

Request body

isTeamFieldboolean

Return only fields with the specified isTeamField value.

requiredboolean

Return only fields with the specified required value.

workspaceIdsstring[]

Return only fields which are installed in the specified workspaces.

Response

totalItemsinteger required

Example response

{
  "items": [
    {
      "_embedded": {
        "workspaces": [
          {
            "order": 42
          }
        ]
      }
    }
  ]
}

Changes

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