> 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/show/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.staging.frame.io/_mcp/server.

# Show metadata

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

Show the metadata of a file. Rate Limits: 100 calls per 1.00 minute(s) per account\_user

Reference: https://developer.staging.frame.io/platform/api-reference/metadata/show

## 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)
- `file_id` (string, required)

### Query parameters

- `show_null` (boolean, optional)

## Response

### 200

OK

- `data` (MetadataWithDefinition, required)

## 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

### MetadataWithDefinition

- `file_id` (string, required) — File ID
- `metadata` (list of MetadataField, required) — Metadata fields values

### 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)

### MetadataField

- `field_type`: `date` (date)
  - `field_definition_id` (string, required) — Field definition ID
  - `field_definition_name` (string, required) — Field definition name
  - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated.
  - `value` (string, required, nullable)
- `field_type`: `long_text` (long_text)
  - `field_definition_id` (string, required) — Field definition ID
  - `field_definition_name` (string, required) — Field definition name
  - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated.
  - `value` (string, required, nullable)
- `field_type`: `number` (number)
  - `field_definition_id` (string, required) — Field definition ID
  - `field_definition_name` (string, required) — Field definition name
  - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated.
  - `value` (double, required, nullable)
- `field_type`: `rating` (rating)
  - `field_definition_id` (string, required) — Field definition ID
  - `field_definition_name` (string, required) — Field definition name
  - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated.
  - `value` (integer, required, nullable)
- `field_type`: `select` (select)
  - `field_definition_id` (string, required) — Field definition ID
  - `field_definition_name` (string, required) — Field definition name
  - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated.
  - `value` (list of SelectOption, required)
  - `field_options` (list of SelectOption, optional)
- `field_type`: `select_multi` (select_multi)
  - `field_definition_id` (string, required) — Field definition ID
  - `field_definition_name` (string, required) — Field definition name
  - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated.
  - `value` (list of SelectOption, required)
  - `field_options` (list of SelectOption, optional)
- `field_type`: `text` (text)
  - `field_definition_id` (string, required) — Field definition ID
  - `field_definition_name` (string, required) — Field definition name
  - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated.
  - `value` (string, required, nullable)
- `field_type`: `toggle` (toggle)
  - `field_definition_id` (string, required) — Field definition ID
  - `field_definition_name` (string, required) — Field definition name
  - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated.
  - `value` (boolean, required, nullable)
- `field_type`: `user_multi` (user_multi)
  - `field_definition_id` (string, required) — Field definition ID
  - `field_definition_name` (string, required) — Field definition name
  - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated.
  - `value` (list of UserValue, required)
  - `custom_members` (list of UserValue, optional) — Populated with costum member options only if `member_options_type` is set to 'custom'.
  - `member_options_type` (enum, optional)
    - Allowed values: `custom`, `all_project_members`
- `field_type`: `user_single` (user_single)
  - `field_definition_id` (string, required) — Field definition ID
  - `field_definition_name` (string, required) — Field definition name
  - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated.
  - `value` (list of UserValue, required)
  - `custom_members` (list of UserValue, optional) — Populated with costum member options only if `member_options_type` is set to 'custom'.
  - `member_options_type` (enum, optional)
    - Allowed values: `custom`, `all_project_members`
- `field_type`: `users` (users)
  - `field_definition_id` (string, required) — Field definition ID
  - `field_definition_name` (string, required) — Field definition name
  - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated.
  - `value` (list of UserValue, required)
  - `custom_members` (list of UserValue, optional) — Populated with costum member options only if `member_options_type` is set to 'custom'.
  - `member_options_type` (enum, optional)
    - Allowed values: `custom`, `all_project_members`

### BadRequestErrorsItemsSource

- `pointer` (string, optional)

### UnauthorizedErrorsItemsSource

- `pointer` (string, optional)

### ForbiddenErrorsItemsSource

- `pointer` (string, optional)

### NotFoundErrorsItemsSource

- `pointer` (string, optional)

### UnprocessableEntityErrorsItemsSource

- `pointer` (string, optional)

### TooManyRequestsErrorsItemsSource

- `pointer` (string, optional)

### SelectOption

- `display_name` (string, required) — Option display name
- `id` (string, required) — Option ID

### UserValue

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

## Examples

**Response**

```json
{
  "data": {
    "file_id": "32da4167-6171-4bee-9d1e-081572081975",
    "metadata": [
      {
        "field_type": "select_multi",
        "field_definition_id": "bfcf8f07-2f7d-413e-99ac-9c4eec9266fa",
        "field_definition_name": "Fields definition name",
        "mutable": true,
        "value": [
          {
            "display_name": "Display name",
            "id": "6ec91e7f-6411-4bd5-98fe-202662275123"
          }
        ],
        "field_options": [
          {
            "display_name": "Display name",
            "id": "6ec91e7f-6411-4bd5-98fe-202662275123"
          },
          {
            "display_name": "Display name 2",
            "id": "4b4147a7-59e7-48eb-a779-03a2e18259d1"
          }
        ]
      },
      {
        "field_type": "text",
        "field_definition_id": "bfcf8f07-2f7d-413e-99ac-9c4eec9266fa",
        "field_definition_name": "Fields definition name",
        "mutable": true,
        "value": "text value"
      }
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.frame.io/v4/accounts/4d57cf24-0667-479c-a6af-4c9817fbdf9a/files/711f8734-cebc-4ed7-94fa-7c59f34d8659/metadata"

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

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

print(response.json())
```

```javascript
const url = 'https://api.frame.io/v4/accounts/4d57cf24-0667-479c-a6af-4c9817fbdf9a/files/711f8734-cebc-4ed7-94fa-7c59f34d8659/metadata';
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/4d57cf24-0667-479c-a6af-4c9817fbdf9a/files/711f8734-cebc-4ed7-94fa-7c59f34d8659/metadata"

	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/4d57cf24-0667-479c-a6af-4c9817fbdf9a/files/711f8734-cebc-4ed7-94fa-7c59f34d8659/metadata")

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/4d57cf24-0667-479c-a6af-4c9817fbdf9a/files/711f8734-cebc-4ed7-94fa-7c59f34d8659/metadata")
  .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/4d57cf24-0667-479c-a6af-4c9817fbdf9a/files/711f8734-cebc-4ed7-94fa-7c59f34d8659/metadata', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.frame.io/v4/accounts/4d57cf24-0667-479c-a6af-4c9817fbdf9a/files/711f8734-cebc-4ed7-94fa-7c59f34d8659/metadata");
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/4d57cf24-0667-479c-a6af-4c9817fbdf9a/files/711f8734-cebc-4ed7-94fa-7c59f34d8659/metadata")! 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()
```