curl --request GET \
--url https://api.example.com/api/v1/ops/export-resources/{resource} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/ops/export-resources/{resource}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/ops/export-resources/{resource}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/ops/export-resources/{resource}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/ops/export-resources/{resource}"
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(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/ops/export-resources/{resource}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/ops/export-resources/{resource}")
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{
"exportResourceId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"resource": "order",
"label": "Orders",
"permission": "export:order",
"formats": [
"CSV",
"XLSX"
],
"defaultFormat": "CSV",
"defaultColumns": [
"code",
"status"
],
"columns": [
{
"field": "code",
"label": "Code",
"type": "STRING",
"values": [
"PENDING",
"PAID"
],
"sensitive": false
}
],
"filters": [
{
"field": "createdAt",
"label": "Created at",
"type": "STRING",
"operators": [
"BETWEEN"
],
"values": null,
"required": true
}
],
"status": "ACTIVE",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "Orders by status and period",
"maxRows": 100000,
"deletedAt": "2023-11-07T05:31:56Z"
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Insufficient permissions",
"statusCode": 403
}{
"message": "Internal Server Error",
"statusCode": 500
}Get Export Resource
Returns an export resource.
curl --request GET \
--url https://api.example.com/api/v1/ops/export-resources/{resource} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/ops/export-resources/{resource}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/ops/export-resources/{resource}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/ops/export-resources/{resource}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/ops/export-resources/{resource}"
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(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/ops/export-resources/{resource}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/ops/export-resources/{resource}")
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{
"exportResourceId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"resource": "order",
"label": "Orders",
"permission": "export:order",
"formats": [
"CSV",
"XLSX"
],
"defaultFormat": "CSV",
"defaultColumns": [
"code",
"status"
],
"columns": [
{
"field": "code",
"label": "Code",
"type": "STRING",
"values": [
"PENDING",
"PAID"
],
"sensitive": false
}
],
"filters": [
{
"field": "createdAt",
"label": "Created at",
"type": "STRING",
"operators": [
"BETWEEN"
],
"values": null,
"required": true
}
],
"status": "ACTIVE",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "Orders by status and period",
"maxRows": 100000,
"deletedAt": "2023-11-07T05:31:56Z"
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Insufficient permissions",
"statusCode": 403
}{
"message": "Internal Server Error",
"statusCode": 500
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Stable export resource key
"order"
Query Parameters
Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.
Response
OK
Export resource
Export resource identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"
Stable export resource key
"order"
Export resource label
"Orders"
Permission required to export the resource
"export:order"
Supported export formats
1Export file format
CSV, XLSX ["CSV", "XLSX"]
Export file format
CSV, XLSX "CSV"
Default export columns
1["code", "status"]
Allowed export columns
1Show child attributes
Show child attributes
Allowed export filters
Show child attributes
Show child attributes
Export resource status
ACTIVE, INACTIVE "ACTIVE"
Creation timestamp
Last update timestamp
Export resource description
"Orders by status and period"
Maximum rows per export
100000
Soft deletion timestamp