Export a global field
GET https://{{base_url}}/v3/global_fields/{{global_field_uid}}/export
This request is used to export a specific global field and its schema. The data is exported in JSON format. The exported file won’t get downloaded automatically. To download the exported file, a REST API client, such as Qodex can be used.
To configure the permissions for your application via OAuth, please include the cm.global-fields.management:write scope.
To use the API Request, you will need to authenticate yourself either with a Management Token (highly recommended) or an Authtoken.
Read more about it in Authentication.
For more information, refer to the Export a global field API Reference document
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
include_branch | boolean | Set this to 'true' to include the '_branch' top-level key in the response. This key states the unique ID of the branch where the concerned Contentstack module resides. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
api_key | string | ||
authtoken | string | Enter your authtoken. | |
authorization | string | For this call we recommend you to use management token. | |
branch | string | Enter your branch unique ID. | |
Content-Type | string |