logo

Request an organization data export

Request an organization data export. The data export is asynchronously processed.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json
includeFiles
boolean
Default: false

Sets the export to include organization files.

Responses
201

Organization data export request received.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
id
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

userId
string

ID of the user who requested the organization data export.

fileId
string or null

ID of the linked file object.

status
string

Status of organization data export request.

Enum: "pending" "processing" "completed" "queued" "failed" "expired"
Array of objects (OrganizationExportResource)

Organization data export resources array.

Array
name
string

Exported resource.

Enum: Description
customers

All customers of the organization.

users

All users of the organization.

payment-instruments

All payment instruments of the organization.

invoices

All invoices of the organization.

orders

All orders of the organization.

transactions

All transactions of the organization.

disputes

All disputes of the organization.

gateway-accounts

All gateway accounts of the organization.

blocklists

All blocklists of the organization.

lists

All lists of the organization.

… 7 more
recordCount
integer

Number of exported resources.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

retentionTime
string or null <date-time>

Date and time when retention ends. After this date, files are removed.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "user" "signedLink"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

post/organization-exports
Request samples
application/json
{
  • "includeFiles": true
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "userId": "string",
  • "fileId": "string",
  • "status": "pending",
  • "items": [
    ],
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "retentionTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Retrieve an organization data export request