List Sheets
curl --request GET \
--url https://api.csvbox.io/1.1/sheet \
--header 'Accept: <accept>' \
--header 'x-csvbox-api-key: <api-key>' \
--header 'x-csvbox-secret-api-key: <api-key>'import requests
url = "https://api.csvbox.io/1.1/sheet"
headers = {
"Accept": "<accept>",
"x-csvbox-api-key": "<api-key>",
"x-csvbox-secret-api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
Accept: '<accept>',
'x-csvbox-api-key': '<api-key>',
'x-csvbox-secret-api-key': '<api-key>'
}
};
fetch('https://api.csvbox.io/1.1/sheet', 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.csvbox.io/1.1/sheet",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"x-csvbox-api-key: <api-key>",
"x-csvbox-secret-api-key: <api-key>"
],
]);
$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.csvbox.io/1.1/sheet"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "<accept>")
req.Header.Add("x-csvbox-api-key", "<api-key>")
req.Header.Add("x-csvbox-secret-api-key", "<api-key>")
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.csvbox.io/1.1/sheet")
.header("Accept", "<accept>")
.header("x-csvbox-api-key", "<api-key>")
.header("x-csvbox-secret-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.csvbox.io/1.1/sheet")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Accept"] = '<accept>'
request["x-csvbox-api-key"] = '<api-key>'
request["x-csvbox-secret-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"sheet_id": 123,
"sheet_license_key": "a1b2c3d4",
"title": "Customer Import",
"created_via": "<string>",
"columns_count": 123,
"import_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 3,
"per_page": 20,
"to": 20,
"total": 42
}
}{
"status": "Sheet Creation Failed",
"errors": {
"virtual_columns.0.js_code": [
{
"code": "js_disallowed_global",
"message": "Disallowed global `fetch`. Snippets may only reference the `csvbox` argument, standard built-ins, and globals declared in this item's dependencies.",
"identifier": "fetch",
"line": 1,
"column": 7
}
]
}
}List sheets
Returns a paginated list of sheets owned by the authenticated API user.
GET
/
1.1
/
sheet
List Sheets
curl --request GET \
--url https://api.csvbox.io/1.1/sheet \
--header 'Accept: <accept>' \
--header 'x-csvbox-api-key: <api-key>' \
--header 'x-csvbox-secret-api-key: <api-key>'import requests
url = "https://api.csvbox.io/1.1/sheet"
headers = {
"Accept": "<accept>",
"x-csvbox-api-key": "<api-key>",
"x-csvbox-secret-api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
Accept: '<accept>',
'x-csvbox-api-key': '<api-key>',
'x-csvbox-secret-api-key': '<api-key>'
}
};
fetch('https://api.csvbox.io/1.1/sheet', 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.csvbox.io/1.1/sheet",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"x-csvbox-api-key: <api-key>",
"x-csvbox-secret-api-key: <api-key>"
],
]);
$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.csvbox.io/1.1/sheet"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "<accept>")
req.Header.Add("x-csvbox-api-key", "<api-key>")
req.Header.Add("x-csvbox-secret-api-key", "<api-key>")
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.csvbox.io/1.1/sheet")
.header("Accept", "<accept>")
.header("x-csvbox-api-key", "<api-key>")
.header("x-csvbox-secret-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.csvbox.io/1.1/sheet")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Accept"] = '<accept>'
request["x-csvbox-api-key"] = '<api-key>'
request["x-csvbox-secret-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"sheet_id": 123,
"sheet_license_key": "a1b2c3d4",
"title": "Customer Import",
"created_via": "<string>",
"columns_count": 123,
"import_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 3,
"per_page": 20,
"to": 20,
"total": 42
}
}{
"status": "Sheet Creation Failed",
"errors": {
"virtual_columns.0.js_code": [
{
"code": "js_disallowed_global",
"message": "Disallowed global `fetch`. Snippets may only reference the `csvbox` argument, standard built-ins, and globals declared in this item's dependencies.",
"identifier": "fetch",
"line": 1,
"column": 7
}
]
}
}Headers
Must be application/json
Example:
"application/json"
Query Parameters
Page number (1-indexed). Defaults to 1.
Required range:
x >= 1Sheets per page. Defaults to 20, clamped to a maximum of 100.
Required range:
1 <= x <= 100
