Rebilly API Docs

Retrieve organization data exports

Retrieves a list of organization data exports.

SecuritySecretApiKey or JWT

Request

limit	integer [ 0 .. 1000 ] Limits the number of collection items to be returned.
offset	integer >= 0 Specifies the starting point within the collection of items to be returned.
filter	string Filters the collection items. This field requires a special format. Use `,` for multiple allowed values. Use `;` for multiple fields. For more information, see Using filter with collections.
q	string Use this field to perform a partial search of text fields.
sort	Array of strings Sorts and orders the collection of items. To sort in descending order, prefix with `-`.

Responses

200

List of organization data exports retrieved.

Response Headers
Pagination-Total	integer Total number of items. Example: 332
Pagination-Limit	integer Maximum number of items per page. Example: 100
Pagination-Offset	integer Specifies the starting point within the collection of resource results. For example, a request with `limit=20` retrieves and displays the first 20 results on a page. A following request with `limit=20` and `offset=20`, retrieves the next page of 20 results. Example: 2

Array

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