> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.staging.frame.io/platform/v4/api-reference/metadata-fields/metadata-field-definitions-index/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.staging.frame.io/_mcp/server.

# List account level field definitions

GET https://api.frame.io/v4/accounts/{account_id}/metadata/field_definitions

List account level field definitions. Rate Limits: 100 calls per 1.00 minute(s) per account\_user

Reference: https://developer.staging.frame.io/platform/api-reference/metadata-fields/metadata-field-definitions-index

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `account_id` (string, required)

### Query parameters

- `filters` (V4AccountsAccountIdMetadataFieldDefinitionsGetParametersFilters, optional)
- `include` (enum, optional)
  - Allowed values: `creator`
- `after` (string, optional) — Opaque Cursor query param for requests returning paginated results. NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
- `page_size` (integer, optional, default: 50)
- `include_total_count` (boolean, optional, default: false)

## Response

### 200

OK

- `data` (list of FieldDefinitionWithIncludes, required) — Field definitions
- `links` (Links, required) — Links to paginated data
- `total_count` (integer, optional, nullable) — Total count

## Errors

### 400 Bad Request Error

Bad Request

- `errors` (list of BadRequestErrorsItems, required)

### 401 Unauthorized Error

Unauthorized

- `errors` (list of UnauthorizedErrorsItems, required)

### 403 Forbidden Error

Forbidden

- `errors` (list of ForbiddenErrorsItems, required)

### 404 Not Found Error

Not Found

- `errors` (list of NotFoundErrorsItems, required)

### 422 Unprocessable Entity Error

Unprocessable Entity

- `errors` (list of UnprocessableEntityErrorsItems, required)

### 429 Too Many Requests Error

Too Many Requests

- `errors` (list of TooManyRequestsErrorsItems, required)

## Types

### V4AccountsAccountIdMetadataFieldDefinitionsGetParametersFilters

Filter parameters

- `exclude_immutable` (boolean, optional) — Filters out read-only fields.
- `exclude_inactive` (boolean, optional) — Filters out inactive fields.

### FieldDefinitionWithIncludes

- `field_type`: `date` (date)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (DateDefinitionFieldConfiguration, required)
  - `id` (string, required) — Field definition ID
  - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated.
  - `name` (string, required) — FieldDefinition Name
  - `updated_at` (string, required) — Updated Timestamp
  - `creator` (User, optional) — User details
- `field_type`: `long_text` (long_text)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (LongTextDefinitionFieldConfiguration, required)
  - `id` (string, required) — Field definition ID
  - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated.
  - `name` (string, required) — FieldDefinition Name
  - `updated_at` (string, required) — Updated Timestamp
  - `creator` (User, optional) — User details
- `field_type`: `number` (number)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (NumberDefinitionFieldConfiguration, required)
  - `id` (string, required) — Field definition ID
  - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated.
  - `name` (string, required) — FieldDefinition Name
  - `updated_at` (string, required) — Updated Timestamp
  - `creator` (User, optional) — User details
- `field_type`: `rating` (rating)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (RatingDefinitionFieldConfiguration, required)
  - `id` (string, required) — Field definition ID
  - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated.
  - `name` (string, required) — FieldDefinition Name
  - `updated_at` (string, required) — Updated Timestamp
  - `creator` (User, optional) — User details
- `field_type`: `select` (select)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (SelectDefinitionFieldConfiguration, required)
  - `id` (string, required) — Field definition ID
  - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated.
  - `name` (string, required) — FieldDefinition Name
  - `updated_at` (string, required) — Updated Timestamp
  - `creator` (User, optional) — User details
- `field_type`: `select_multi` (select_multi)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (SelectMultiDefinitionFieldConfiguration, required)
  - `id` (string, required) — Field definition ID
  - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated.
  - `name` (string, required) — FieldDefinition Name
  - `updated_at` (string, required) — Updated Timestamp
  - `creator` (User, optional) — User details
- `field_type`: `text` (text)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (TextDefinitionFieldConfiguration, required)
  - `id` (string, required) — Field definition ID
  - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated.
  - `name` (string, required) — FieldDefinition Name
  - `updated_at` (string, required) — Updated Timestamp
  - `creator` (User, optional) — User details
- `field_type`: `toggle` (toggle)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (ToggleDefinitionFieldConfiguration, required)
  - `id` (string, required) — Field definition ID
  - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated.
  - `name` (string, required) — FieldDefinition Name
  - `updated_at` (string, required) — Updated Timestamp
  - `creator` (User, optional) — User details
- `field_type`: `user_multi` (user_multi)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (UserMultiDefinitionFieldConfiguration, required)
  - `id` (string, required) — Field definition ID
  - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated.
  - `name` (string, required) — FieldDefinition Name
  - `updated_at` (string, required) — Updated Timestamp
  - `creator` (User, optional) — User details
- `field_type`: `user_single` (user_single)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (UserSingleDefinitionFieldConfiguration, required)
  - `id` (string, required) — Field definition ID
  - `mutable` (boolean, required) — Field definition mutability. System fields cannot be updated.
  - `name` (string, required) — FieldDefinition Name
  - `updated_at` (string, required) — Updated Timestamp
  - `creator` (User, optional) — User details

### Links

Links to paginated data

- `next` (string, required, nullable) — "Link to next page of data. This link is the request path with the addition of the `after` query parameter to fetch the next page of results. Optional query parameters `page_size` and `include_total_count` are supported when paginating data."

### BadRequestErrorsItems

- `detail` (string, required)
- `source` (BadRequestErrorsItemsSource, optional)
- `title` (string, optional)

### UnauthorizedErrorsItems

- `detail` (string, required)
- `source` (UnauthorizedErrorsItemsSource, optional)
- `title` (string, optional)

### ForbiddenErrorsItems

- `detail` (string, required)
- `source` (ForbiddenErrorsItemsSource, optional)
- `title` (string, optional)

### NotFoundErrorsItems

- `detail` (string, required)
- `source` (NotFoundErrorsItemsSource, optional)
- `title` (string, optional)

### UnprocessableEntityErrorsItems

- `detail` (string, required)
- `source` (UnprocessableEntityErrorsItemsSource, optional)
- `title` (string, optional)

### TooManyRequestsErrorsItems

- `detail` (string, required)
- `source` (TooManyRequestsErrorsItemsSource, optional)
- `title` (string, optional)

### DateDefinitionFieldConfiguration

- `display_format` (enum, required, default: local)
  - Allowed values: `local`, `friendly`, `usa`, `euro`, `iso`
- `display_timezone` (boolean, optional, default: false)
- `include_time` (boolean, optional, default: false)
- `time_format` (enum, optional, default: twelve_hour)
  - Allowed values: `twelve_hour`, `twenty_four_hour`

### User

User details

- `active` (boolean, required, nullable) — User active status
- `avatar_url` (string, required, nullable) — User avatar image url
- `email` (string, required) — User email
- `id` (string, required, nullable) — User ID - can be null for invited users with no frame account
- `name` (string, required, nullable) — User name
- `adobe_user_id` (string, optional, nullable) — Adobe user ID

### LongTextDefinitionFieldConfiguration

### NumberDefinitionFieldConfiguration

- `scale` (integer, required) — Number scale. Indicates the number of decimal places of precision for the number value
- `number_format` (enum, optional, nullable) — Number format
  - Allowed values: `bitrate`, `bits`, `duration`, `framerate`, `frequency`, `storage`, `timecode`

### RatingDefinitionFieldConfiguration

- `max_value` (integer, required)
- `color` (string, optional, nullable) — Color value hex code for the `style` icon symbols. ex: #fbd400
- `style` (enum, optional, nullable) — Field type
  - Allowed values: `star`, `heart`, `thumbs_up`

### SelectDefinitionFieldConfiguration

- `options` (list of SelectDefinitionFieldConfigurationOptionsItems, required)
- `enable_add_new` (boolean, optional, default: true) — Allow or disallow adding in new option(s) from the grid/list view

### SelectMultiDefinitionFieldConfiguration

- `options` (list of SelectMultiDefinitionFieldConfigurationOptionsItems, required)
- `enable_add_new` (boolean, optional, default: true) — Allow or disallow adding in new option(s) from the grid/list view

### TextDefinitionFieldConfiguration

### ToggleDefinitionFieldConfiguration

- `color` (string, required, nullable) — Color value hex code. ex: #fbd400

### UserMultiDefinitionFieldConfiguration

- `custom_members` (list of UserMultiDefinitionFieldConfigurationCustomMembersItems, required)
- `member_options_type` (enum, required)
  - Allowed values: `all_project_members`, `custom`
- `notify_members` (boolean, required)

### UserSingleDefinitionFieldConfiguration

- `custom_members` (list of UserSingleDefinitionFieldConfigurationCustomMembersItems, required)
- `member_options_type` (enum, required)
  - Allowed values: `all_project_members`, `custom`
- `notify_members` (boolean, required)

### BadRequestErrorsItemsSource

- `pointer` (string, optional)

### UnauthorizedErrorsItemsSource

- `pointer` (string, optional)

### ForbiddenErrorsItemsSource

- `pointer` (string, optional)

### NotFoundErrorsItemsSource

- `pointer` (string, optional)

### UnprocessableEntityErrorsItemsSource

- `pointer` (string, optional)

### TooManyRequestsErrorsItemsSource

- `pointer` (string, optional)

### SelectDefinitionFieldConfigurationOptionsItems

- `display_name` (string, required) — Option display name
- `color` (string, optional, nullable) — Color value hex code for the `display_name`. ex: #fbd400
- `id` (string, optional)

### SelectMultiDefinitionFieldConfigurationOptionsItems

- `display_name` (string, required) — Option display name
- `color` (string, optional, nullable) — Color value hex code for the `display_name`. ex: #fbd400
- `id` (string, optional)

### UserMultiDefinitionFieldConfigurationCustomMembersItems

- `id` (string, required) — User Id
- `type` (enum, required)
  - Allowed values: `user`, `account_user_group`

### UserSingleDefinitionFieldConfigurationCustomMembersItems

- `id` (string, required) — User Id
- `type` (enum, required)
  - Allowed values: `user`, `account_user_group`

## Examples

**Response**

```json
{
  "data": [
    {
      "field_type": "select",
      "created_at": "2024-01-25T19:18:29.614189Z",
      "creator_id": "890ca621-d866-4b1b-b8c7-5a40c36ad72b",
      "field_configuration": {
        "options": [
          {
            "display_name": "Option 1",
            "id": "8c262c61-9fa2-4eae-a261-ee7c9aee2423"
          },
          {
            "display_name": "Option 2",
            "id": "3709d94a-3bb6-4afe-9992-a671535fe6de"
          }
        ],
        "enable_add_new": false
      },
      "id": "a10e2eaf-2032-4a58-863d-28b4102b1ddb",
      "mutable": true,
      "name": "Fields definition name",
      "updated_at": "2024-02-07T16:44:41.986478Z"
    },
    {
      "field_type": "select",
      "created_at": "2024-01-25T19:18:29.614189Z",
      "creator_id": "4d982c95-2060-42fb-adff-db19bdaf923b",
      "field_configuration": {
        "options": [
          {
            "display_name": "Option 1",
            "id": "61ab4ee9-fe7b-4ae2-ae66-6a6114563514"
          },
          {
            "display_name": "Option 2",
            "id": "b685fda2-c3c0-401e-b4ca-10ea5aa372b6"
          }
        ],
        "enable_add_new": false
      },
      "id": "25016225-e7a0-46d0-953e-031265675369",
      "mutable": true,
      "name": "Fields definition name",
      "updated_at": "2024-02-07T16:44:41.986478Z"
    }
  ],
  "links": {
    "next": "/v4/accounts/1234/workspaces/5678/projects?after=g3QAAAACZAACaWRtAAAAJGFiMmNiY2QzLWFkODQtNDQwMC05YTRkLWE1ZDRkMGE4ZTIxM2QABG5hbWVtAAAACVByb2plY3QgMg=="
  },
  "total_count": 10
}
```

**SDK Code**

```python
import requests

url = "https://api.frame.io/v4/accounts/73a8845b-d504-401b-b529-dbe131b8abf7/metadata/field_definitions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.frame.io/v4/accounts/73a8845b-d504-401b-b529-dbe131b8abf7/metadata/field_definitions';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.frame.io/v4/accounts/73a8845b-d504-401b-b529-dbe131b8abf7/metadata/field_definitions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.frame.io/v4/accounts/73a8845b-d504-401b-b529-dbe131b8abf7/metadata/field_definitions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.frame.io/v4/accounts/73a8845b-d504-401b-b529-dbe131b8abf7/metadata/field_definitions")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.frame.io/v4/accounts/73a8845b-d504-401b-b529-dbe131b8abf7/metadata/field_definitions', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.frame.io/v4/accounts/73a8845b-d504-401b-b529-dbe131b8abf7/metadata/field_definitions");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.frame.io/v4/accounts/73a8845b-d504-401b-b529-dbe131b8abf7/metadata/field_definitions")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```