Skip to content
Documentation

List Exports

GET
/api/v1/workspaces/{workspace_id}/exports
curl --request GET \
  --url 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/exports?per=10&page=1' \
  --header 'Authorization: Bearer <token>'

Retrieves the exports.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
integer

Workspace ID

Query Parameters

Section titled “Query Parameters”
per
integer
default: 10

Number of records per page

page
integer
default: 1

Page number

email_id
integer

Only return exports of this email

Responses

Section titled “Responses”

200

Section titled “200”

Successful

Media typeapplication/json
object
results
required
Array<object>
object
id
required
integer
organization_id
required
integer
connector_id
required
integer | null
cdn_connector_id
required
integer | null
email_id
required
integer
email
required
object
id
integer
name
string
dynamic_content_profile_id
required
string | null
status
required
string
Allowed values: in_progress completed failed
export_type
required
string
Allowed values: json html connector
image_mode
required
string
Allowed values: use_cdn include_in_zip use_cdn_connector use_export_connector
minify_html
required
boolean
folder_id
required
string | null
campaign_id
required
string | null
export_field_values
required
object | null
outputs
required

One entry per exported locale. For connector exports, the resource created or overwritten in the connector.

Array<object>
object
locale
required

A BCP 47 language tag identifying the language and region of a piece of content. Must carry both a language and a region subtag, and must be in canonical case (lowercase language, titlecase script, uppercase region) — en-GB, not en-gb or en_GB. The region may be a UN M.49 code, so en-001 (world) is valid.

string
name
required

The name of the output. For connector exports, the name of the resource in the connector. Null for a resource being overwritten until the export completes.

string | null
external_id
required

The ID of the resource in the connector. Null for html and json exports, and until a connector export completes.

string | null
url
required

A link to open the resource in the connector. Null for html and json exports, and until a connector export completes.

string | null
integration_name
required
string | null
metadata
required
object
conditional_ids
Array<integer>
personalization_tag_ids
Array<integer>
image_ids
Array<integer>
export_errors
required
object
base
Array<string> | null
additionalProperties
object
key
additional properties
Array<string>
created_at
required
string format: date-time
updated_at
required
string format: date-time
download_zip_url
required

Set once an html export completes.

string | null
download_json_url
required

Set once a json export completes.

string | null
pagination
required
object
per
required
integer
page
required
integer
total
required
integer
Example
{
  "results": [
    {
      "id": 12345,
      "organization_id": 12345,
      "connector_id": 12345,
      "cdn_connector_id": 12345,
      "email_id": 12345,
      "email": {
        "id": 12345
      },
      "dynamic_content_profile_id": "a8c5c5c0-5b1a-4b5a-9b0a-5e8b5c5c5c5c",
      "status": "in_progress",
      "export_type": "json",
      "image_mode": "use_cdn",
      "outputs": [
        {
          "locale": "en-GB",
          "name": "Spring Sale (EN)",
          "external_id": "tpl_456",
          "url": "https://dashboard.braze.com/engagement/templates/tpl_456"
        }
      ],
      "integration_name": "Brevo",
      "metadata": {
        "conditional_ids": [
          12345
        ],
        "personalization_tag_ids": [
          12345
        ],
        "image_ids": [
          12345
        ]
      },
      "export_errors": {
        "base": [
          "My Error"
        ],
        "additionalProperties": {
          "additionalProperty": [
            "My Error"
          ]
        }
      },
      "created_at": "2023-08-23T10:30:00.000Z",
      "updated_at": "2023-08-23T10:30:00.000Z",
      "download_zip_url": "https://www.example.com/download.zip",
      "download_json_url": "https://www.example.com/download.json"
    }
  ],
  "pagination": {
    "per": 10,
    "page": 1,
    "total": 100
  }
}