Organization data exports

Organization data exports.

Retrieve a list of organization data exports.

Retrieve a list of organization data exports.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

q
string

The partial search of the text fields.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

Responses
200

A list of organization data exports is successfully retrieved.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

userId
string

ID of the user who requested the organization data export.

fileId
string or null

Linked File object id.

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.

webhooks

All webhooks of the organization.

webhooks-tracking

All webhooks tracking items of the organization.

… 2 more
recordCount
integer

Number of exported resources.

createdTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

retentionTime
string or null <date-time>

Retention end date. After this date, files will be removed.

Array of LinkSelf (object) or LinkUser (object) or LinkSignedLink (object) [ 1 .. 3 ] items

Links related to the resource.

Array ([ 1 .. 3 ] items)
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/organization-exports
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/organization-exports?limit=1000&offset=0&filter=string&q=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Request an organization data export.

Request an organization data export.

SecuritySecretApiKey or JWT
Responses
201

Organization data export request received.

Response Schema: application/json
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

userId
string

ID of the user who requested the organization data export.

fileId
string or null

Linked File object id.

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.

webhooks

All webhooks of the organization.

webhooks-tracking

All webhooks tracking items of the organization.

… 2 more
recordCount
integer

Number of exported resources.

createdTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

retentionTime
string or null <date-time>

Retention end date. After this date, files will be removed.

Array of LinkSelf (object) or LinkUser (object) or LinkSignedLink (object) [ 1 .. 3 ] items

Links related to the resource.

Array ([ 1 .. 3 ] items)
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/organization-exports
Request samples
curl -i -X POST \
  https://api-sandbox.rebilly.com/organizations/unknown/organization-exports \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
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": [
    ]
}

Retrieve an organization data export request.

Retrieve an organization data export request.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Responses
200

Organization data export request.

Response Schema: application/json
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

userId
string

ID of the user who requested the organization data export.

fileId
string or null

Linked File object id.

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.

webhooks

All webhooks of the organization.

webhooks-tracking

All webhooks tracking items of the organization.

… 2 more
recordCount
integer

Number of exported resources.

createdTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

retentionTime
string or null <date-time>

Retention end date. After this date, files will be removed.

Array of LinkSelf (object) or LinkUser (object) or LinkSignedLink (object) [ 1 .. 3 ] items

Links related to the resource.

Array ([ 1 .. 3 ] items)
Any of:
rel
required
string

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/organization-exports/{id}
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/organization-exports/{id}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
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": [
    ]
}