Skip to main content
POST
Export workspace data

Authorizations

Authorization
string
header
required

Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: Authorization: Bearer <token>

Path Parameters

workspaceId
string
required

The workspace ID

Pattern: ^ws_[a-z0-9]+$

Body

application/json
format
enum<string>
default:json
Available options:
json,
csv,
xlsx
include_products
boolean
default:true
include_members
boolean
default:true
include_audit_logs
boolean
default:false

Response

Export job created successfully

job_id
string

Unique export job identifier

status
enum<string>
Available options:
queued,
processing
created_at
string<date-time>
Last modified on February 16, 2026