Skip to main content
GET
/
studies
/
{studyId}
/
consent-submissions
/
export
/
{exportId}
Get consent submission export status
curl --request GET \
  --url https://api.rallyuxr.com/api/public/v1/studies/{studyId}/consent-submissions/export/{exportId} \
  --header 'Authorization: Bearer <token>'
{
  "exportId": "<string>",
  "status": "NOT_STARTED",
  "processedCount": 123,
  "totalCount": 123,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "downloadUrl": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
studyId
string
required

The study ID

​
exportId
string
required

The export ID

Response

Export status retrieved successfully

​
exportId
string
required

The export ID

​
status
enum<string>
required

The current status of the export

Available options:
NOT_STARTED,
EXPORTING,
COMPLETED,
ERROR
​
processedCount
number
required

Number of consent submissions processed so far

​
totalCount
number
required

Total number of consent submissions to export

​
createdAt
string
required

When the export was created

​
updatedAt
string
required

When the export was last updated

​
downloadUrl
string

Pre-signed S3 URL to download the ZIP file. Expires after 5 minutes. Only present when status is COMPLETED.