Rehive logo
Powered by Redocly

exports

List exports

SecurityapiAuth
Request
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

resource
string
status
string
Responses
200
get/3/exports/
Response samples
application/json
{
  • "status": "success",
  • "data": {}
}

Create export

SecurityapiAuth
Request
Request Body schema:
required
resource
required
string
  • account - Account
  • account_currency - Account_Currency
  • transaction - Transaction
  • user - User
Enum: "account" "account_currency" "transaction" "user"
page_size
integer or null
object or null
file_format
string
  • json - JSON
  • csv - CSV
Enum: "json" "csv"
Responses
202
post/3/exports/
Request samples
{
  • "resource": "account",
  • "page_size": 0,
  • "query": {
    },
  • "file_format": "json"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve export

SecurityapiAuth
Request
path Parameters
identifier
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
get/3/exports/{identifier}/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}
➔ Next to groups