/
Retrieve organization dat...

Retrieve organization data exports

Request

Retrieves a list of organization data exports.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

qstring

Use this field to perform a partial search of text fields.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/organization-exports?limit=0&offset=0&filter=string&q=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of organization data exports retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
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.

]
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": [ … ]
  }
]