Skip to main content
GET
Get Sheet

Authorizations

x-csvbox-api-key
string
header
required
x-csvbox-secret-api-key
string
header
required

Headers

Accept
string
required

Must be application/json

Example:

"application/json"

Path Parameters

sheet_license_key
string
required

Sheet's numeric sheet_id or its slug (sheet_license_key)

Response

Sheet found

sheet_id
integer
Example:

123

sheet_license_key
string
Example:

"a1b2c3d4"

title
string
Example:

"Customer Import"

created_via
string
columns_count
integer
import_count
integer
created_at
string<date-time>
updated_at
string<date-time>
sheet_columns
object[]
virtual_columns
object[]
validation_functions
object[]
data_transforms
object[]
destination
string

Only the configured destination's type is shown. One of webhook, testapi, xano or none (the values destinations[].type accepts on POST/PUT/PATCH, aliased back from their internal storage form) when the destination was configured through this API. A destination configured only through the dashboard — every type besides those four has no write-API surface, same as display.theme — reports that destination's own internal type name instead (e.g. mysql, salesforce, airtable) so the field stays meaningful; such a value cannot be round-tripped via PUT/PATCH. none when no destination is configured. No destination's credentials or settings (host, password, API key, tokens, mappings, etc.) ever appear here, for any destination.

Example:

"webhook"

webhooks
object[]

Always exactly one entry, reflecting the import-completion webhook actually stored — same shape as the webhooks array accepted by POST/PUT/PATCH.

security_settings
object
display
object
steps
object

Step settings under the same step and field names accepted by POST/PUT/PATCH's steps (file_upload, select_header, map_columns, verify_data, results) — no credentials. Coded/mapped values (e.g. copy_delimiter, split_confirm) are converted back to what a caller sends.

pdf_metadata_config
object[]

Same shape accepted by POST/PUT/PATCH. Empty array or absent field when unconfigured.