Request an organization data export

Request

Request an organization data export. The data export is asynchronously processed.
Security
SecretApiKey or JWT
Bodyapplication/json
includeFilesboolean
Sets the export to include organization files.
Default:false
Example:true
curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/organization-exports \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "includeFiles": true
  }'

Responses

Organization data export request received.
Headers
Locationstring, (uri)
Location of the related resource.
Example:"https://api.rebilly.com/example"
Rate-Limit-Limitinteger

Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.

Example:500
Rate-Limit-Remaininginteger

Number of requests still available for this rate limit. For more information, see Rate limits.

Example:499
Bodyapplication/json
idstring, <= 50 charactersread-only
Unique resource ID.
Example:"org_exp_01HXC7MKK4GCS6WRRXY4X9CRMK"
userIdstring, <= 50 charactersread-only
ID of the user who requested the organization data export.
Example:"usr_0YVCEENYJ3D7Q9EN6BN16HA0G4"
fileIdstring or null, <= 50 charactersread-only
ID of the linked file object.
Example:"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"
statusstringread-only
Status of organization data export request.
Enum:"pending""processing""completed""queued""failed""expired"
resourcesArray of objectsread-only
Organization data export resources array.
createdTimestring, (date-time)(CreatedTime)read-only
Date and time when the resource is created. This value is set automatically when the resource is created.
updatedTimestring, (date-time)(UpdatedTime)read-only
Date and time when the resource is updated. This value is set automatically when the resource is updated.
retentionTimestring or null, (date-time)read-only
Date and time when retention ends. After this date, files are removed.
_linksArray of objectsread-only
Related links.
Response
{
  "id": "org_exp_01HXC7MKK4GCS6WRRXY4X9CRMK",
  "userId": "usr_0YVCEENYJ3D7Q9EN6BN16HA0G4",
  "fileId": "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N",
  "status": "pending",
  "resources": [
    { … }
  ],
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "retentionTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}