Skip to content

Get a field

Request

Get a Field resource.

When Field.hasFixedOptions = true the FieldOption resources for this Field can be retrieved via an FieldOptionSearch

To fetch several fields at once, use GET Fields.

Security
bearerToken
Path
idstringrequired

The unique ID of the field

Example:cfb665ca-ce35-4418-b9d5-70ee815db4bd
curl -i -X GET \
  https://api-v2.dash.app/fields/cfb665ca-ce35-4418-b9d5-70ee815db4bd \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
resultobjectrequired
permittedActionsArray of objectsrequired
Response
{
  "result": {
    "id": "a52b5315-15b8-417f-b742-d6902108bac1",
    "accountId": "cfb665ca-ce35-4418-b9d5-70ee815db4bd",
    "name": "Folders",
    "dataType": "STRING",
    "multiValue": true,
    "hasFixedOptions": true,
    "hierarchical": true,
    "editControl": "FOLDER_PICKER",
    "contributorsCanCreateFieldOptions": true,
    "indestructible": true,
    "recommended": true,
    "defaultSortField": "FIELD_ID",
    "browsable": true,
    "entityType": "ASSET",
    "lookupType": "PRODUCT_VARIANT_CRITERION"
  },
  "permittedActions": [
    { … }
  ]
}