# List custom field keys

Lists custom field keys for the matching Brandfolder.

Endpoint: GET /brandfolders/{brandfolder_id}/custom_field_keys
Version: v4
Security: APIToken

## Path parameters:

  - `brandfolder_id` (string, required)
    Unique identifier for the resource instance.
    Example: "oqgiju-21olts-ce9egi"

## Header parameters:

  - `Content-Type` (string, required)
    Enum: "application/json"

  - `Accept` (string, required)
    Enum: "application/json"

  - `Authorization` (string, required)
    Bearer token for authentication

## Query parameters:

  - `fields` (string)
    Set it to value to return it as part of the asset's attributes in the
response.

Allowed value: value

WARNING: This parameter can slow response times.
    Example: "value"

  - `include` (string)
    Set it to custom_field_values to return those records related to the
asset you're fetching. Related records are returned in an included
array in the response.

Allowed value: custom_field_values

WARNING: This parameter can slow response times.
    Example: "custom_field_values"

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.id` (string, required)
    Unique identifier for the resource instance.
    Example: "plqlkk-22rw6g-3dqgx0"

  - `data.type` (string, required)
    The type of the resource.
    Enum: "custom_field_keys"

  - `data.attributes` (object, required)

  - `data.attributes.name` (string, required)
    The key name.
    Example: "color"

  - `data.attributes.allowed_values` (array)
    The value that can be used with this key when creating or updating any Custom Field on an Asset must be one of these strings. If not included or empty array [], the values are unrestricted.
    Example: ["red","white","blue"]

  - `data.attributes.position` (integer)
    Sets the location of the custom field among other custom fields in the Brandfolder UI.

  - `data.attributes.prioritized` (boolean)
    Set to true to display the custom field in asset previews. A Brandfolder can have up to five prioritized custom fields.

  - `data.attributes.required` (boolean)
    If set to true, users uploading an asset must input the custom field before uploading the asset. Children of dependent custom fields can also be marked as required.

  - `data.attributes.restricted` (boolean)
    If set to true, the field value is restricted to a set of allowed values (see allowed_values); otherwise, the field value is unrestricted.
    Example: true

  - `meta` (object, required)
    Page context information.

  - `meta.current_page` (integer, required)
    Example: 1

  - `meta.next_page` (object,null, required)

  - `meta.prev_page` (object,null, required)

  - `meta.total_pages` (number, required)
    Example: 1

  - `meta.total_count` (number, required)
    Example: 1