---
title: "List field configurations"
method: GET
path: "/api/v2/assets/field-configurations"
tags: ["Assets"]
---

# List field configurations

`GET /api/v2/assets/field-configurations`

## Request

- Base URL: `https://console.jumpcloud.com`
- URL: `https://console.jumpcloud.com/api/v2/assets/field-configurations`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/docs/api/v2/assets/field-configurations/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of field configurations available for assets. Field configurations define all fields and their properties for organizing asset data.

## Response `200`

Field configurations retrieved successfully

- JumpcloudHttpAssetsListFieldConfigsResponse: Response containing a paginated list of field configurations
  - `results` JumpcloudHttpAssetsFieldConfig[], required: Array of field configurations
    - `id` string, required: The unique identifier of the field configuration
    - `label` string, required: The display label for the field
    - `default` boolean, required: Whether this is a default/system field
    - `mandatory` boolean, required: Whether the field is required
    - `scope` 'Common' | 'Device' | 'Accessory' | 'Location', required: The asset type(s) this field applies to
  - `totalCount` integer, required: Total number of field configurations available

## Other responses

- `400`: Bad request - invalid query parameters
- `401`: Unauthorized - authentication required
- `default`: Generic error response

---

[API](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/revisions/f396d9271b46?raw)