Export

Description

Export a record view. The response can be passed to the import endpoint to recreate the record view in another team or tenant.

See the List Record Views API to learn more about record views.

Request

HTTP Method: GET

curl -X GET \
  https://<tenant-domain>/api/v1/record_views/<<record_view_id>>/export \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON object representing the record view in exported form.

Field description

To recreate a record view in another team or tenant, pass the entire export object (including schema_version) as the data parameter to the Import Record View API.

Each entry in elements has an id, and each entry in layout has a matching i value that references the element it lays out. Preserve both when passing the export to the import endpoint.

Sample response

{
  "schema_version": 1,
  "export_type": "record_view",
  "exported_at": "2025-02-10T12:30:45Z",
  "record_view": {
    "name": "Open cases by priority",
    "report_view": "chart",
    "elements": [
      {
        "id": "a1b2c3d4e5f6",
        "name": "Priority breakdown",
        "record_type_name": "Cases",
        "element_type": "bar_chart",
        "axes": [
          {
            "direction": "X",
            "record_field_name": "priority"
          }
        ],
        "aggregation": "COUNT",
        "rolling_date_range": "LAST_7_DAYS",
        "range_start": null,
        "range_end": null,
        "filters": {
          "stories": [],
          "fields": [
            {
              "value": "open",
              "operator": "EQUAL",
              "name": "status"
            }
          ]
        },
        "order": {
          "field": null,
          "direction": "DESC"
        },
        "color_palette": "colorful",
        "options": {},
        "record_fields": [],
        "test_mode": false
      }
    ],
    "layout": [
      {
        "i": "a1b2c3d4e5f6",
        "h": 4,
        "w": 6,
        "x": 0,
        "y": 0
      }
    ]
  }
}