Skip to main content
POST
/
api
/
workspace
/
{workspaceId}
/
export
Export workspace data
curl --request POST \
  --url https://app.alana.shopping/api/workspace/{workspaceId}/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "format": "json",
  "include_products": true,
  "include_members": true,
  "include_audit_logs": false
}
'
{
  "job_id": "export_abc123def456",
  "status": "queued",
  "created_at": "2024-02-15T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Obtain a token via the authentication endpoint and include it in the Authorization header: Authorization: Bearer <token>

Path Parameters

​
workspaceId
string
required

The workspace ID

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>