Skip to main content
GET
Read export progress and its verified 24-hour download capability

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
export_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Current export state and optional verified SQL ZIP download.

id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
project_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
state
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancelled
requested_at
string<date-time>
required
next_request_at
string<date-time>
required
next_poll_after_seconds
enum<integer> | null
required
Available options:
5,
null
error
object | null
required
archive
object | null
required