Data

Endpoint to destroy user data

DELETE

https://firefly.example.com/api/v1/data/destroy

A call to this endpoint deletes the requested data type. Use it with care and always with user permission. The demo user is incapable of using this endpoint.

curl -X DELETE 'https://firefly.example.com/api/v1/data/destroy?objects=not_assets_liabilities' \
  -H 'X-Trace-Id: 40c71bbb-c676-4f24-83cf-cc725d7d7a00' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://firefly.example.com/api/v1/data/destroy?objects=not_assets_liabilities', {
  method: 'DELETE',
  headers: {
    'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://firefly.example.com/api/v1/data/destroy?objects=not_assets_liabilities',
    headers={
        'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

{
  "message": "Bad Request",
  "exception": "BadRequestHttpException"
}

{
  "message": "Unauthenticated",
  "exception": "AuthenticationException"
}

{
  "message": "Resource not found",
  "exception": "NotFoundHttpException"
}

{
  "message": "Internal Exception",
  "exception": "InternalException"
}

Parameters

objectsDataDestroyObjectnot_assets_liabilitiesbudgetsbillspiggy_banksrulesrecurringcategoriestagsobject_groupsaccountsasset_accountsexpense_accountsrevenue_accountsliabilitiestransactionswithdrawalsdepositstransfersrequiredquery

The type of data that you wish to destroy. You can only use one at a time.

unusedArray<integer>query

Only applies when "objects" is set to: not_assets_liabilities, accounts, asset_accounts, expense_accounts, revenue_accounts or liabilities.

If set to true, only unused accounts will be destroyed. This effectively cleans up the autocomplete dropdowns.

Response

204No Content

Empty response when data has been destroyed.

400Bad RequestBadRequestResponse

Bad request

Response fields application/json

messagestring

Example

Bad Request

exceptionstring

Example

BadRequestHttpException

401UnauthorizedUnauthenticatedResponse

Unauthenticated

Response fields application/json

messagestring

Example

Unauthenticated

exceptionstring

Example

AuthenticationException

404Not FoundNotFoundResponse

Page not found

Response fields application/json

messagestring

Example

Resource not found

exceptionstring

Example

NotFoundHttpException

500Internal Server ErrorInternalExceptionResponse

Internal exception

Response fields application/json

messagestring

Example

Internal Exception

exceptionstring

Example

InternalException

Authorization

firefly_iii_authoauth2

OAuth2 authorization code flow. Create a client on your installation's /profile page; it authorizes at /oauth/authorize and issues tokens at /oauth/token there. The URLs below are the demo site's. How to use the API walks through it.

local_bearer_authhttp (bearer)

A Personal Access Token, sent as a bearer token. Create one on your installation under Options > Profile > OAuth > Personal Access Tokens.