Configuration

Get a single Firefly III system configuration value

GET

https://firefly.example.com/api/v1/configuration/{name}

Returns one configuration variable for this Firefly III installation

curl -X GET 'https://firefly.example.com/api/v1/configuration/configuration.is_demo_site' \
  -H 'X-Trace-Id: 40c71bbb-c676-4f24-83cf-cc725d7d7a00' \
  -H 'Authorization: Bearer YOUR_TOKEN'

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

const data = await response.text();

import requests

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

{
  "data": {
    "title": "configuration.is_demo_site",
    "value": true,
    "editable": true
  }
}

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

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

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

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

Parameters

nameConfigValueFilterconfiguration.is_demo_siteconfiguration.permission_update_checkconfiguration.last_update_checkconfiguration.single_user_modefirefly.versionfirefly.default_locationfirefly.account_to_transactionfirefly.allowed_opposing_typesfirefly.accountRolesfirefly.valid_liabilitiesfirefly.interest_periodsfirefly.enable_external_mapfirefly.expected_source_typesapp.timezonefirefly.bill_periodsfirefly.credit_card_typesfirefly.languagesfirefly.valid_view_rangescer.enabledfirefly.preselected_accountsfirefly.rule-actionsfirefly.context-rule-actionssearch.operatorswebhook.triggerswebhook.responseswebhook.deliveriesrequiredpath

The name of the configuration value you want to know.

Response

200OKConfigurationSingle

One system configuration value

Response fields application/json

dataConfigurationrequired

Show child attributes

titleConfigValueFilterconfiguration.is_demo_siteconfiguration.permission_update_checkconfiguration.last_update_checkconfiguration.single_user_modefirefly.versionfirefly.default_locationfirefly.account_to_transactionfirefly.allowed_opposing_typesfirefly.accountRolesfirefly.valid_liabilitiesfirefly.interest_periodsfirefly.enable_external_mapfirefly.expected_source_typesapp.timezonefirefly.bill_periodsfirefly.credit_card_typesfirefly.languagesfirefly.valid_view_rangescer.enabledfirefly.preselected_accountsfirefly.rule-actionsfirefly.context-rule-actionssearch.operatorswebhook.triggerswebhook.responseswebhook.deliveriesrequired

Title of the configuration value.

Example

configuration.is_demo_site

valueboolean | string | object | Array<StringArrayItem>required

Show child attributes

One of

boolean

string

object

Array<StringArrayItem>

editablebooleanrequired

If this config variable can be edited by the user

Example

true

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.