> This page is for Plataforma, version V4 experimental.
> For other versions, use one of these documentation indexes:
> - V4 (default): https://developer.frame.io/platform/v4/llms.txt
> - V4 experimental: https://developer.frame.io/platform/v4-experimental/llms.txt
> - Herdado: https://developer.frame.io/platform/v2/llms.txt

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

# Mostrar compartilhamento

GET https://api.frame.io/v4/accounts/{account_id}/shares/{share_id}

Show a share. Rate Limits: 100 calls per 1.00 minute(s) per account\_user

Reference: https://developer.frame.io/platform/api-reference/shares/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)
- `share_id` (string, required)

### Query parameters

- `include` (enum, optional)
  - Allowed values: `featured_field_definition`, `visible_field_definitions`

### Headers

- `api-version` (enum, required)
  - Allowed values: `experimental`

## Response

### 200

OK

- `data` (ExperimentalShareWithIncludes, 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)

### 409 Conflict Error

Conflict

- `errors` (list of ConflictErrorsItems, required)

### 422 Unprocessable Entity Error

Unprocessable content

- `errors` (list of UnprocessableContentErrorsItems, required)

### 429 Too Many Requests Error

Too many requests

- `errors` (list of TooManyRequestsErrorsItems, required)

## Types

### ExperimentalShareWithIncludes

- `enabled` (boolean, required) — Whether the share link is active
- `watermark_template_id` (string, required, nullable) — ID of the session watermark template applied when watermarking is enabled on the share. Must belong to the share's account. When omitted or null, the workspace or account default template is used.
- `access` (enum, required)
  - Allowed values: `public`, `secure`
- `last_viewed_at` (string, required, nullable) — Last viewed timestamp
- `updated_at` (string, required) — Update timestamp
- `editable_fields_enabled` (boolean, required) — When true, all visible non-system fields can be edited by share recipients. When false, only the featured field is editable.
- `commenting_enabled` (boolean, required) — Whether commenting is enabled on the share
- `description` (string, required, nullable) — Share description
- `sort_by` (ExperimentalShareWithIncludesSortBy, required) — Field ID and direction by which share assets will be sorted
- `created_at` (string, required) — Creation timestamp
- `forensic_watermark_enabled` (boolean, required) — Whether forensic watermarking is enabled on the share
- `name` (string, required, nullable) — Share name
- `collection_id` (string, required) — Collection ID
- `short_url` (string, required, nullable) — Share URL
- `drm_enabled` (boolean, required) — Whether digital rights management is enabled on the share
- `watermark_enabled` (boolean, required, nullable) — Whether watermarking is enabled on the share
- `featured_field_definition_id` (string, required, nullable) — ID of the field definition to set as the featured (always-editable) field for share recipients
- `downloading_enabled` (boolean, required) — Whether downloading is enabled on the share
- `id` (string, required) — Share ID
- `expiration` (string, required, nullable) — Expiration timestamp
- `visible_field_definition_ids` (list of string, required) — IDs of field definitions to show in the share. Applies to the share's active layout. When omitted, inherits from the project's default field visibility.
- `card_info_enabled` (boolean, optional) — Whether to show card info (metadata) on cards when layout is grid
- `icons_visible_on_list` (boolean, optional) — Whether visible-field icons are shown alongside text when layout is list
- `theme` (enum, optional) — Color theme
  - Allowed values: `dark`, `light`, `neutral`
- `card_aspect_ratio` (enum, optional) — Aspect ratio of cards. Applies to layouts: grid, reel.
  - Allowed values: `horizontal`, `square`, `vertical`
- `passphrase` (string, optional, nullable) — Passphrase to access share, if passphrase is required and not given it will be generated
- `list_row_size` (enum, optional) — Row size when layout is list
  - Allowed values: `small`, `medium`, `large`
- `card_size` (enum, optional) — Relative size of cards when layout is grid
  - Allowed values: `small`, `medium`, `large`
- `reel_card_aspect_ratio` (enum, optional) — Aspect ratio of cards when layout is reel
  - Allowed values: `horizontal`, `square`, `vertical`
- `show_asset_name_in_reel_layout` (boolean, optional) — Whether the asset name is displayed when layout is reel
- `captions_enabled` (boolean, optional, nullable) — Whether reviewers can view captions on shared assets
- `transcripts_enabled` (boolean, optional, nullable) — Whether reviewers can view transcripts on shared assets
- `reel_card_fit_image` (boolean, optional) — Thumbnail scale when layout is reel. `true` fills the card (may crop); `false` fits the thumbnail inside the card.
- `open_in_viewer_enabled` (boolean, optional) — Whether shares with a single asset will open in a larger view. Applies to layouts: grid, list.
- `accent_color` (string, optional, nullable) — Hex code for accent color
- `layout` (enum, optional) — Share layout. Required when updating appearance fields
  - Allowed values: `grid`, `list`, `reel`
- `show_all_asset_versions` (boolean, optional, nullable) — Whether reviewers can see every version in a shared version stack (rather than only the head version)
- `name_column_width` (integer, optional, nullable) — Width of the name column in pixels when layout is list
- `thumbnail_scale` (enum, optional) — Thumbnail scale. `fill` may crop; `fit` letterboxes inside the card.
  - Allowed values: `fit`, `fill`
- `title_line_count` (integer, optional) — Number of lines for the card title (1 or 2) when layout is grid
- `featured_field_definition` (ExperimentalShareWithIncludesFeaturedFieldDefinition, optional, nullable) — Full `featured_field_definition` object
- `visible_field_definitions` (list of FieldDefinition, optional) — Full field-definition objects for `visible_field_definition_ids`

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

### ConflictErrorsItems

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

### UnprocessableContentErrorsItems

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

### TooManyRequestsErrorsItems

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

### ExperimentalShareWithIncludesSortBy

Field ID and direction by which share assets will be sorted

- `direction` (enum, required)
  - Allowed values: `asc`, `desc`
- `field_definition_id` (string, required) — A UUID string that uniquely identifies a Frame.io entity.

### ExperimentalShareWithIncludesFeaturedFieldDefinition

Full `featured_field_definition` object

- FieldDefinition: FieldDefinition

### FieldDefinition

- `field_type`: `date` (DateDefinition)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (FieldDefinitionDiscriminatorMappingDateFieldConfiguration, 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
- `field_type`: `long_text` (LongTextDefinition)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (FieldDefinitionDiscriminatorMappingLongTextFieldConfiguration, 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
- `field_type`: `number` (NumberDefinition)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (FieldDefinitionDiscriminatorMappingNumberFieldConfiguration, 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
- `field_type`: `rating` (RatingDefinition)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (FieldDefinitionDiscriminatorMappingRatingFieldConfiguration, 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
- `field_type`: `select` (SelectDefinition)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (FieldDefinitionDiscriminatorMappingSelectFieldConfiguration, 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
- `field_type`: `select_multi` (SelectMultiDefinition)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (FieldDefinitionDiscriminatorMappingSelectMultiFieldConfiguration, 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
- `field_type`: `text` (TextDefinition)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (FieldDefinitionDiscriminatorMappingTextFieldConfiguration, 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
- `field_type`: `toggle` (ToggleDefinition)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (FieldDefinitionDiscriminatorMappingToggleFieldConfiguration, 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
- `field_type`: `user_multi` (UserMultiDefinition)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (FieldDefinitionDiscriminatorMappingUserMultiFieldConfiguration, 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
- `field_type`: `user_single` (UserSingleDefinition)
  - `created_at` (string, required) — Created Timestamp
  - `creator_id` (string, required) — Field definition creator ID
  - `field_configuration` (FieldDefinitionDiscriminatorMappingUserSingleFieldConfiguration, 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

### BadRequestErrorsItemsSource

- `pointer` (string, optional)

### UnauthorizedErrorsItemsSource

- `pointer` (string, optional)

### ForbiddenErrorsItemsSource

- `pointer` (string, optional)

### NotFoundErrorsItemsSource

- `pointer` (string, optional)

### ConflictErrorsItemsSource

- `pointer` (string, optional)

### UnprocessableContentErrorsItemsSource

- `pointer` (string, optional)

### TooManyRequestsErrorsItemsSource

- `pointer` (string, optional)

### FieldDefinitionDiscriminatorMappingDateFieldConfiguration

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

### FieldDefinitionDiscriminatorMappingLongTextFieldConfiguration

### FieldDefinitionDiscriminatorMappingNumberFieldConfiguration

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

### FieldDefinitionDiscriminatorMappingRatingFieldConfiguration

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

### FieldDefinitionDiscriminatorMappingSelectFieldConfiguration

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

### FieldDefinitionDiscriminatorMappingSelectMultiFieldConfiguration

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

### FieldDefinitionDiscriminatorMappingTextFieldConfiguration

### FieldDefinitionDiscriminatorMappingToggleFieldConfiguration

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

### FieldDefinitionDiscriminatorMappingUserMultiFieldConfiguration

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

### FieldDefinitionDiscriminatorMappingUserSingleFieldConfiguration

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

### FieldDefinitionDiscriminatorMappingSelectFieldConfigurationOptionsItems

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

### FieldDefinitionDiscriminatorMappingSelectMultiFieldConfigurationOptionsItems

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

### FieldDefinitionDiscriminatorMappingUserMultiFieldConfigurationCustomMembersItems

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

### FieldDefinitionDiscriminatorMappingUserSingleFieldConfigurationCustomMembersItems

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

## Examples

**Response**

```json
{
  "data": {
    "enabled": true,
    "watermark_template_id": "8ef77170-9cbd-45df-9d5e-a538231877b3",
    "access": "public",
    "last_viewed_at": "2024-03-02T21:19:24.828948Z",
    "updated_at": "2024-02-02T21:19:24.828948Z",
    "editable_fields_enabled": false,
    "commenting_enabled": true,
    "description": "Description of share",
    "sort_by": {
      "direction": "asc",
      "field_definition_id": "dad73a8b-ec71-4729-baf2-42d00d0638f4"
    },
    "created_at": "2024-02-02T21:19:24.828948Z",
    "forensic_watermark_enabled": false,
    "name": "Test Share",
    "collection_id": "59be2601-437c-404a-bf15-7bb3d5e16bac",
    "short_url": "https://f.io/GGa9wPw5",
    "drm_enabled": false,
    "watermark_enabled": true,
    "featured_field_definition_id": "51a03ae5-ff31-4274-a44e-e62b59a9fc11",
    "downloading_enabled": true,
    "id": "1495288a-7ac4-4a56-a5bb-7e54ff0b8c44",
    "expiration": "2026-10-15T23:54:40.706608Z",
    "visible_field_definition_ids": [
      "568d5a08-384e-4664-a6cb-30d3b09ca5fd"
    ],
    "card_info_enabled": true,
    "icons_visible_on_list": true,
    "theme": "dark",
    "card_aspect_ratio": "square",
    "passphrase": "as!dfj39sd(*",
    "list_row_size": "small",
    "card_size": "medium",
    "reel_card_aspect_ratio": "square",
    "show_asset_name_in_reel_layout": false,
    "captions_enabled": true,
    "transcripts_enabled": true,
    "reel_card_fit_image": false,
    "open_in_viewer_enabled": true,
    "accent_color": "#FF0000",
    "layout": "grid",
    "show_all_asset_versions": true,
    "name_column_width": null,
    "thumbnail_scale": "fill",
    "title_line_count": 1,
    "featured_field_definition": {
      "created_at": "2024-01-25T19:18:29.614189Z",
      "creator_id": "e1138c90-d25f-4fb2-b053-434205a259e8",
      "field_configuration": {
        "enable_add_new": false,
        "options": [
          {
            "display_name": "Option 1",
            "id": "08f0782d-c45b-4686-a420-3626e9e0d44c"
          },
          {
            "display_name": "Option 2",
            "id": "29e3144e-973c-49dd-bd3b-36548360af45"
          }
        ]
      },
      "field_type": "select",
      "id": "cb740cd9-6d95-4268-9a3a-b445c5563c66",
      "mutable": true,
      "name": "Fields definition name",
      "updated_at": "2024-02-07T16:44:41.986478Z"
    },
    "visible_field_definitions": [
      {
        "field_type": "select",
        "created_at": "2024-01-25T19:18:29.614189Z",
        "creator_id": "e1138c90-d25f-4fb2-b053-434205a259e8",
        "field_configuration": {
          "options": [
            {
              "display_name": "Option 1",
              "id": "08f0782d-c45b-4686-a420-3626e9e0d44c"
            },
            {
              "display_name": "Option 2",
              "id": "29e3144e-973c-49dd-bd3b-36548360af45"
            }
          ],
          "enable_add_new": false
        },
        "id": "cb740cd9-6d95-4268-9a3a-b445c5563c66",
        "mutable": true,
        "name": "Fields definition name",
        "updated_at": "2024-02-07T16:44:41.986478Z"
      }
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.frame.io/v4/accounts/55def58d-076a-4152-a169-8a480b10dfbb/shares/7ee0efc7-324d-434b-aa7f-82de70f98045"

querystring = {"include":"featured_field_definition"}

headers = {
    "api-version": "experimental",
    "Authorization": "Bearer <token>"
}

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

print(response.json())
```

```javascript
const url = 'https://api.frame.io/v4/accounts/55def58d-076a-4152-a169-8a480b10dfbb/shares/7ee0efc7-324d-434b-aa7f-82de70f98045?include=featured_field_definition';
const options = {
  method: 'GET',
  headers: {'api-version': 'experimental', 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/55def58d-076a-4152-a169-8a480b10dfbb/shares/7ee0efc7-324d-434b-aa7f-82de70f98045?include=featured_field_definition"

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

	req.Header.Add("api-version", "experimental")
	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/55def58d-076a-4152-a169-8a480b10dfbb/shares/7ee0efc7-324d-434b-aa7f-82de70f98045?include=featured_field_definition")

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

request = Net::HTTP::Get.new(url)
request["api-version"] = 'experimental'
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/55def58d-076a-4152-a169-8a480b10dfbb/shares/7ee0efc7-324d-434b-aa7f-82de70f98045?include=featured_field_definition")
  .header("api-version", "experimental")
  .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/55def58d-076a-4152-a169-8a480b10dfbb/shares/7ee0efc7-324d-434b-aa7f-82de70f98045?include=featured_field_definition', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'api-version' => 'experimental',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.frame.io/v4/accounts/55def58d-076a-4152-a169-8a480b10dfbb/shares/7ee0efc7-324d-434b-aa7f-82de70f98045?include=featured_field_definition");
var request = new RestRequest(Method.GET);
request.AddHeader("api-version", "experimental");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "api-version": "experimental",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.frame.io/v4/accounts/55def58d-076a-4152-a169-8a480b10dfbb/shares/7ee0efc7-324d-434b-aa7f-82de70f98045?include=featured_field_definition")! 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()
```