id
stringlengths 53
86
| api_name
stringlengths 2
76
| api_description
stringlengths 1
500
⌀ | api_score
float64 0
10
⌀ | endpoint_name
stringlengths 1
190
| endpoint_description
stringlengths 0
500
| response_status_code
int64 100
505
| response_summary
stringlengths 1
68
⌀ | response_json
stringlengths 6
50k
| response_json_schema
stringlengths 14
150k
|
|---|---|---|---|---|---|---|---|---|---|
984e1681-43a4-47ba-9a52-77f2c3ee6648/d4f30458-4f43-4aec-bc35-101c38370eed/0/0 | Esport Tournament Engine | A fully managed tournament Engine that comes with rich features to organize bespoke esports competitions on demand. | null | CheckIn participant | CheckIn/Out a participant before a fixture. | 200 | Response | {"message": "The participant has successfully checked-in."} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"message": {"type": "string"}}, "required": ["message"]} |
984e1681-43a4-47ba-9a52-77f2c3ee6648/de1c7598-d9ce-4398-ab5f-69853be597b1/0/0 | Esport Tournament Engine | A fully managed tournament Engine that comes with rich features to organize bespoke esports competitions on demand. | null | Start tounament manually | This feature only applies to League, Two Stages and Free For All formats. | 200 | Response | {"message": "The tournament has started successfully."} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"message": {"type": "string"}}, "required": ["message"]} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/dd004462-aa8a-4960-9557-970c6c9d6b5f/0/0 | FF3 | FF3 KEY | null | getAccountsAC | 200 | null | [{"id": "2", "name": "Checking Account", "name_with_balance": "Checking Account ($123.45)", "type": "Asset account", "currency_id": "12", "currency_name": "Euro", "currency_code": "EUR", "currency_symbol": "$", "currency_decimal_places": 2}] | {"type": "array", "items": {"type": "object", "required": ["id", "name", "name_with_balance", "type", "currency_id", "currency_name", "currency_code", "currency_symbol", "currency_decimal_places"], "properties": {"id": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string", "description": "Name of the account found by an auto-complete search."}, "name_with_balance": {"type": "string", "format": "string", "description": "Asset accounts and liabilities have a second field with the given date's account balance."}, "type": {"type": "string", "format": "string", "description": "Account type of the account found by the auto-complete search."}, "currency_id": {"type": "string", "format": "string", "description": "ID for the currency used by this account."}, "currency_name": {"type": "string", "format": "string", "description": "Currency name for the currency used by this account."}, "currency_code": {"type": "string", "format": "string", "description": "Currency code for the currency used by this account."}, "currency_symbol": {"type": "string", "format": "string", "description": "Currency symbol for the currency used by this account."}, "currency_decimal_places": {"type": "integer", "format": "int32", "description": "Number of decimal places for the currency used by this account.", "minimum": -2147483648, "maximum": 2147483647}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/cec04c1a-e740-4452-843f-3c5775f55cf6/0/0 | FF3 | FF3 KEY | null | insightExpenseAsset | This endpoint gives a summary of the expenses made by the user, grouped by asset account. | 200 | null | [{"id": "123", "name": "Land lord", "difference": "-123.45", "difference_float": -123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "string", "description": "This ID is a reference to the original object."}, "name": {"type": "string", "format": "string", "description": "This is the name of the object."}, "difference": {"type": "string", "format": "string", "description": "The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/e974ca30-0f53-4947-87b3-e6b31ce6d698/1/0 | FF3 | FF3 KEY | null | updateObjectGroup | Update existing object group. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/28ba50e3-bf07-4dfa-9983-ba721f29350b/0/0 | FF3 | FF3 KEY | null | getTransactionsAC | 200 | null | [{"id": "2", "transaction_group_id": "2", "name": "Transaction", "description": "Transaction"}] | {"type": "array", "items": {"type": "object", "required": ["id", "name", "description"], "properties": {"id": {"type": "string", "format": "string", "description": "The ID of a transaction journal (basically a single split)."}, "transaction_group_id": {"type": "string", "format": "string", "description": "The ID of the underlying transaction group."}, "name": {"type": "string", "format": "string", "description": "Transaction description"}, "description": {"type": "string", "format": "string", "description": "Transaction description"}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/6364c37b-e2c0-472e-b532-2c16b27e2157/1/0 | FF3 | FF3 KEY | null | updateBill | Update existing bill. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/a6dd0164-f2d0-4552-ae27-c8173066e83e/0/0 | FF3 | FF3 KEY | null | insightExpenseNoBill | This endpoint gives a summary of the expenses made by the user, including only expenses with no bill. | 200 | null | [{"difference": "123.45", "difference_float": 123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"difference": {"type": "string", "format": "string", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this expense account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this expense account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/ed03dd4a-adfe-4c29-a619-5e953ee461ee/0/0 | FF3 | FF3 KEY | null | getCurrenciesCodeAC | 200 | null | [{"id": "2", "name": "Currency name (XCN)", "code": "EUR", "symbol": "$", "decimal_places": 2}] | {"type": "array", "items": {"type": "object", "required": ["id", "name", "code", "symbol", "decimal_places"], "properties": {"id": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string", "description": "Currency name with the code between brackets."}, "code": {"type": "string", "format": "string", "description": "Currency code."}, "symbol": {"type": "string", "format": "string"}, "decimal_places": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/4607cf7a-b043-4f3e-bd4b-f08ba9a3e8f0/1/0 | FF3 | FF3 KEY | null | updatePiggyBank | Update existing piggy bank. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/d2658467-51ed-406b-bf5c-cc5a9ab0cc76/0/0 | FF3 | FF3 KEY | null | getRulesAC | 200 | null | [{"id": "2", "name": "Rule one", "description": "Useful rule."}] | {"type": "array", "items": {"type": "object", "required": ["id", "name"], "properties": {"id": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string", "description": "Name of the rule found by an auto-complete search."}, "description": {"type": "string", "format": "string", "description": "Description of the rule found by auto-complete."}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/151b6628-cad9-4d6f-bdc3-42ec238d38ca/0/0 | FF3 | FF3 KEY | null | updateAvailableBudget | Update existing available budget. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/0cc25409-4b1e-4eef-bd82-c0de73cdd79a/0/0 | FF3 | FF3 KEY | null | insightExpenseBudget | This endpoint gives a summary of the expenses made by the user, grouped by (any) budget. | 200 | null | [{"id": "123", "name": "Land lord", "difference": "-123.45", "difference_float": -123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "string", "description": "This ID is a reference to the original object."}, "name": {"type": "string", "format": "string", "description": "This is the name of the object."}, "difference": {"type": "string", "format": "string", "description": "The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/c25ffc08-9432-4a1d-814d-a54a57a61ed6/0/0 | FF3 | FF3 KEY | null | storeTag | Creates a new tag. The data required can be submitted as a JSON body or as a list of parameters. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/6d6b3ece-678f-4eaa-aadf-2acedcd493d3/0/0 | FF3 | FF3 KEY | null | insightExpenseTag | This endpoint gives a summary of the expenses made by the user, grouped by (any) tag. | 200 | null | [{"id": "123", "name": "Land lord", "difference": "-123.45", "difference_float": -123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "string", "description": "This ID is a reference to the original object."}, "name": {"type": "string", "format": "string", "description": "This is the name of the object."}, "difference": {"type": "string", "format": "string", "description": "The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/3b3fbc01-7f6d-42c2-b012-92a2d36613c1/0/0 | FF3 | FF3 KEY | null | storePiggyBank | Creates a new piggy bank. The data required can be submitted as a JSON body or as a list of parameters. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/078d9d2f-1c22-4c0c-b2b5-b4f3e6f58949/0/0 | FF3 | FF3 KEY | null | insightTransfers | This endpoint gives a summary of the transfers made by the user, grouped by asset account or lability. | 200 | null | [{"id": "123", "name": "Land lord", "difference": "-123.45", "difference_float": -123.45, "in": "123.45", "in_float": 123.45, "out": "123.45", "out_float": 123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "string", "description": "This ID is a reference to the original object."}, "name": {"type": "string", "format": "string", "description": "This is the name of the object."}, "difference": {"type": "string", "format": "string", "description": "The total amount transferred between start date and end date, a number defined as a string, for this asset account."}, "difference_float": {"type": "number", "format": "double", "description": "The total amount transferred between start date and end date, a number as a float, for this asset account. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "in": {"type": "string", "format": "string", "description": "The total amount transferred TO this account between start date and end date, a number defined as a string, for this asset account."}, "in_float": {"type": "number", "format": "double", "description": "The total amount transferred FROM this account between start date and end date, a number as a float, for this asset account. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "out": {"type": "string", "format": "string", "description": "The total amount transferred FROM this account between start date and end date, a number defined as a string, for this asset account."}, "out_float": {"type": "number", "format": "double", "description": "The total amount transferred TO this account between start date and end date, a number as a float, for this asset account. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/9cd8b36e-a10f-4c1f-bb9e-472cf76985c8/0/0 | FF3 | FF3 KEY | null | updateAttachment | Update the meta data for an existing attachment. This endpoint does not allow you to upload or download data. For that, see below. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/b733a334-12e0-4d64-9df6-9d1d3402d78f/0/0 | FF3 | FF3 KEY | null | updateTag | Update existing tag. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/47ee13be-650d-4563-bff2-3429eaceab74/0/0 | FF3 | FF3 KEY | null | insightExpenseCategory | This endpoint gives a summary of the expenses made by the user, grouped by (any) category. | 200 | null | [{"id": "123", "name": "Land lord", "difference": "-123.45", "difference_float": -123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "string", "description": "This ID is a reference to the original object."}, "name": {"type": "string", "format": "string", "description": "This is the name of the object."}, "difference": {"type": "string", "format": "string", "description": "The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/b5fc08d7-6b4c-4caf-8318-5f58f7c4e98f/0/0 | FF3 | FF3 KEY | null | storeBudgetLimit | Store a new budget limit under this budget. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/a68ad4db-007c-40b5-a75a-acfac3872d1b/0/0 | FF3 | FF3 KEY | null | getBillsAC | 200 | null | [{"id": "2", "name": "Yearly bill"}] | {"type": "array", "items": {"type": "object", "required": ["id", "name"], "properties": {"id": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string", "description": "Name of the bill found by an auto-complete search."}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/6cab30b7-d0dc-42f8-8284-df4d91bd02c3/0/0 | FF3 | FF3 KEY | null | insightExpenseNoCategory | This endpoint gives a summary of the expenses made by the user, including only expenses with no category. | 200 | null | [{"difference": "123.45", "difference_float": 123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"difference": {"type": "string", "format": "string", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this expense account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this expense account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/b26b30a4-7d2f-44d0-abc5-30e884c0fe53/0/0 | FF3 | FF3 KEY | null | insightIncomeTotal | This endpoint gives a sum of the total income received by the user. | 200 | null | [{"difference": "123.45", "difference_float": 123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"difference": {"type": "string", "format": "string", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this expense account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this expense account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/57eebea3-4ac6-47fc-ae15-82f5fcca8aaa/0/0 | FF3 | FF3 KEY | null | getRecurringAC | 200 | null | [{"id": "2", "name": "Yearly bill", "description": "Should trigger daily."}] | {"type": "array", "items": {"type": "object", "required": ["id", "name"], "properties": {"id": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string", "description": "Name of the recurrence found by an auto-complete search."}, "description": {"type": "string", "format": "string", "description": "Description of the recurrence found by auto-complete."}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/f34aef89-eb02-4736-9dcc-c3126a129cb8/0/0 | FF3 | FF3 KEY | null | storeBudget | Creates a new budget. The data required can be submitted as a JSON body or as a list of parameters. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/cdb38eab-ce34-4033-9a5f-262381331b03/0/0 | FF3 | FF3 KEY | null | listTransactionByLinkType | List all transactions under this link type, both the inward and outward transactions. | 200 | null | {"data": [{"type": "transactions", "id": "2", "attributes": {"created_at": "2018-09-17T12:46:47+01:00", "updated_at": "2018-09-17T12:46:47+01:00", "user": "3", "group_title": "Split transaction title.", "transactions": [{"user": "3", "transaction_journal_id": "10421", "type": "withdrawal", "date": "2018-09-17T12:46:47+01:00", "order": 0, "currency_id": "12", "currency_code": "EUR", "currency_symbol": "$", "currency_name": "Euro", "currency_decimal_places": 2, "foreign_currency_id": "17", "foreign_currency_code": "USD", "foreign_currency_symbol": "$", "foreign_currency_decimal_places": 2, "amount": "123.45", "foreign_amount": "123.45", "description": "Vegetables", "source_id": "2", "source_name": "Checking account", "source_iban": "NL02ABNA0123456789", "source_type": "Asset account", "destination_id": "2", "destination_name": "Buy and Large", "destination_iban": "NL02ABNA0123456789", "destination_type": "Asset account", "budget_id": "4", "budget_name": "Groceries", "category_id": "43", "category_name": "Groceries", "bill_id": "111", "bill_name": "Monthly rent", "reconciled": true, "notes": "Some example notes", "tags": ["Barbecue preparation"], "internal_reference": "", "external_id": "", "external_url": "", "original_source": "", "recurrence_id": 0, "recurrence_total": 0, "recurrence_count": 12, "bunq_payment_id": "", "import_hash_v2": "", "sepa_cc": "", "sepa_ct_op": "", "sepa_ct_id": "", "sepa_db": "", "sepa_country": "", "sepa_ep": "", "sepa_ci": "", "sepa_batch_id": "", "interest_date": "", "book_date": "", "process_date": "", "due_date": "", "payment_date": "", "invoice_date": "", "latitude": 51.983333, "longitude": 5.916667, "zoom_level": 6, "has_attachments": true}]}, "links": {"0": {"rel": "self", "uri": "/OBJECTS/1"}, "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"}}], "meta": {"pagination": {"total": 3, "count": 20, "per_page": 100, "current_page": 1, "total_pages": 1}}, "links": {"self": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=4", "first": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=1", "last": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=12"}} | {"type": "object", "required": ["data", "meta", "links"], "properties": {"data": {"type": "array", "items": {"type": "object", "required": ["type", "id", "attributes", "links"], "properties": {"type": {"type": "string", "format": "string", "description": "Immutable value"}, "id": {"type": "string", "format": "string"}, "attributes": {"type": "object", "required": ["transactions"], "properties": {"created_at": {"type": "string", "format": "date-time"}, "updated_at": {"type": "string", "format": "date-time"}, "user": {"type": "string", "format": "string", "description": "User ID"}, "group_title": {"type": ["string", "null"], "format": "string", "description": "Title of the transaction if it has been split in more than one piece. Empty otherwise."}, "transactions": {"type": "array", "items": {"type": "object", "required": ["amount", "source_id", "destination_id", "date", "description", "type"], "properties": {"user": {"type": "string", "format": "string", "description": "User ID"}, "transaction_journal_id": {"type": "string", "format": "string", "description": "ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n"}, "type": {"type": "string", "format": "string", "enum": ["withdrawal", "deposit", "transfer", "reconciliation", "opening balance"]}, "date": {"type": "string", "format": "date-time", "description": "Date of the transaction"}, "order": {"type": ["integer", "null"], "format": "int32", "description": "Order of this entry in the list of transactions.", "minimum": -2147483648, "maximum": 2147483647}, "currency_id": {"type": ["string", "null"], "format": "string", "description": "Currency ID. Default is the source account's currency, or the user's default currency. Can be used instead of currency_code."}, "currency_code": {"type": ["string", "null"], "format": "string", "description": "Currency code. Default is the source account's currency, or the user's default currency. Can be used instead of currency_id."}, "currency_symbol": {"type": "string", "format": "string"}, "currency_name": {"type": "string", "format": "string"}, "currency_decimal_places": {"type": "integer", "format": "int32", "description": "Number of decimals used in this currency.", "minimum": -2147483648, "maximum": 2147483647}, "foreign_currency_id": {"type": ["string", "null"], "format": "string", "description": "Currency ID of the foreign currency. Default is null. Is required when you submit a foreign amount."}, "foreign_currency_code": {"type": ["string", "null"], "format": "string", "description": "Currency code of the foreign currency. Default is NULL. Can be used instead of the foreign_currency_id, but this or the ID is required when submitting a foreign amount."}, "foreign_currency_symbol": {"type": ["string", "null"], "format": "string"}, "foreign_currency_decimal_places": {"type": ["integer", "null"], "format": "int32", "description": "Number of decimals in the currency", "minimum": -2147483648, "maximum": 2147483647}, "amount": {"type": "string", "format": "amount", "description": "Amount of the transaction."}, "foreign_amount": {"type": ["string", "null"], "format": "amount", "description": "The amount in a foreign currency."}, "description": {"type": "string", "format": "string", "description": "Description of the transaction."}, "source_id": {"type": ["string", "null"], "format": "string", "description": "ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account."}, "source_name": {"type": ["string", "null"], "format": "string", "description": "Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name."}, "source_iban": {"type": ["string", "null"], "format": "string"}, "source_type": {"type": "string", "format": "string", "enum": ["Default account", "Cash account", "Asset account", "Expense account", "Revenue account", "Initial balance account", "Beneficiary account", "Import account", "Reconciliation account", "Loan", "Debt", "Mortgage"]}, "destination_id": {"type": ["string", "null"], "format": "string", "description": "ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account."}, "destination_name": {"type": ["string", "null"], "format": "string", "description": "Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough."}, "destination_iban": {"type": ["string", "null"], "format": "string"}, "destination_type": {"type": "string", "format": "string", "enum": ["Default account", "Cash account", "Asset account", "Expense account", "Revenue account", "Initial balance account", "Beneficiary account", "Import account", "Reconciliation account", "Loan", "Debt", "Mortgage"]}, "budget_id": {"type": ["string", "null"], "format": "string", "description": "The budget ID for this transaction."}, "budget_name": {"type": ["string", "null"], "format": "string", "description": "The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored."}, "category_id": {"type": ["string", "null"], "format": "string", "description": "The category ID for this transaction."}, "category_name": {"type": ["string", "null"], "format": "string", "description": "The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name."}, "bill_id": {"type": ["string", "null"], "format": "string", "description": "Optional. Use either this or the bill_name"}, "bill_name": {"type": ["string", "null"], "format": "string", "description": "Optional. Use either this or the bill_id"}, "reconciled": {"type": "boolean", "format": "boolean", "description": "If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user."}, "notes": {"type": ["string", "null"], "format": "string"}, "tags": {"type": ["array", "null"], "description": "Array of tags.", "items": {"type": "string", "format": "string", "description": "Tag."}}, "internal_reference": {"type": ["string", "null"], "format": "string", "description": "Reference to internal reference of other systems."}, "external_id": {"type": ["string", "null"], "format": "string", "description": "Reference to external ID in other systems."}, "external_url": {"type": ["string", "null"], "format": "string", "description": "External, custom URL for this transaction."}, "original_source": {"type": ["string", "null"], "format": "string", "description": "System generated identifier for original creator of transaction."}, "recurrence_id": {"type": ["integer", "null"], "format": "int32", "description": "Reference to recurrence that made the transaction.", "minimum": -2147483648, "maximum": 2147483647}, "recurrence_total": {"type": ["integer", "null"], "format": "int32", "description": "Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite.", "minimum": -2147483648, "maximum": 2147483647}, "recurrence_count": {"type": ["integer", "null"], "format": "int32", "description": "The # of the current transaction created under this recurrence.", "minimum": -2147483648, "maximum": 2147483647}, "bunq_payment_id": {"type": ["string", "null"], "format": "string", "description": "Internal ID of bunq transaction. DEPRECATED"}, "import_hash_v2": {"type": ["string", "null"], "format": "string", "description": "Hash value of original import transaction (for duplicate detection)."}, "sepa_cc": {"type": ["string", "null"], "format": "string", "description": "SEPA Clearing Code"}, "sepa_ct_op": {"type": ["string", "null"], "format": "string", "description": "SEPA Opposing Account Identifier"}, "sepa_ct_id": {"type": ["string", "null"], "format": "string", "description": "SEPA end-to-end Identifier"}, "sepa_db": {"type": ["string", "null"], "format": "string", "description": "SEPA mandate identifier"}, "sepa_country": {"type": ["string", "null"], "format": "string", "description": "SEPA Country"}, "sepa_ep": {"type": ["string", "null"], "format": "string", "description": "SEPA External Purpose indicator"}, "sepa_ci": {"type": ["string", "null"], "format": "string", "description": "SEPA Creditor Identifier"}, "sepa_batch_id": {"type": ["string", "null"], "format": "string", "description": "SEPA Batch ID"}, "interest_date": {"type": ["string", "null"], "format": "date-time"}, "book_date": {"type": ["string", "null"], "format": "date-time"}, "process_date": {"type": ["string", "null"], "format": "date-time"}, "due_date": {"type": ["string", "null"], "format": "date-time"}, "payment_date": {"type": ["string", "null"], "format": "date-time"}, "invoice_date": {"type": ["string", "null"], "format": "date-time"}, "latitude": {"type": ["number", "null"], "format": "double", "description": "Latitude of the transaction's location, if applicable. Can be used to draw a map.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "longitude": {"type": ["number", "null"], "format": "double", "description": "Latitude of the transaction's location, if applicable. Can be used to draw a map.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "zoom_level": {"type": ["integer", "null"], "format": "int32", "description": "Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels.", "minimum": -2147483648, "maximum": 2147483647}, "has_attachments": {"type": "boolean", "format": "boolean", "description": "If the transaction has attachments."}}}}}}, "links": {"type": "object", "properties": {"0": {"type": "object", "properties": {"rel": {"type": "string", "format": "string"}, "uri": {"type": "string", "format": "string"}}}, "self": {"type": "string", "format": "uri"}}}}}}, "meta": {"type": "object", "properties": {"pagination": {"type": "object", "properties": {"total": {"type": "integer"}, "count": {"type": "integer"}, "per_page": {"type": "integer"}, "current_page": {"type": "integer"}, "total_pages": {"type": "integer"}}}}}, "links": {"type": "object", "properties": {"self": {"type": "string", "format": "uri"}, "first": {"type": "string", "format": "uri"}, "last": {"type": "string", "format": "uri"}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/064555db-8b9a-43b2-88fa-a2eb76325a81/1/0 | FF3 | FF3 KEY | null | storeAttachment | Creates a new attachment. The data required can be submitted as a JSON body or as a list of parameters. You cannot use this endpoint to upload the actual file data (see below). This endpoint only creates the attachment object. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/d3d36758-efd5-4e0c-b04f-195a8bb52d6e/0/0 | FF3 | FF3 KEY | null | updateBudgetLimit | Update existing budget limit. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/bf1a8100-d9d6-400b-b761-0c3c5f6b5d7c/0/0 | FF3 | FF3 KEY | null | getPiggiesBalanceAC | 200 | null | [{"id": "2", "name": "New couch", "name_with_balance": "New couch ($ 12.34)", "object_group_id": "5", "object_group_title": "Example Group", "currency_id": "12", "currency_code": "EUR", "currency_symbol": "$", "currency_decimal_places": 2}] | {"type": "array", "items": {"type": "object", "required": ["id", "name"], "properties": {"id": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string", "description": "Name of the piggy bank found by an auto-complete search."}, "name_with_balance": {"type": "string", "format": "string", "description": "Name of the piggy bank found by an auto-complete search with the current balance formatted nicely."}, "object_group_id": {"type": ["string", "null"], "format": "string", "description": "The group ID of the group this object is part of. NULL if no group."}, "object_group_title": {"type": ["string", "null"], "format": "string", "description": "The name of the group. NULL if no group."}, "currency_id": {"type": "string", "format": "string", "description": "Currency ID for this piggy bank."}, "currency_code": {"type": "string", "format": "string", "description": "Currency code for this piggy bank."}, "currency_symbol": {"type": "string", "format": "string"}, "currency_decimal_places": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/26f6ca55-34cd-4814-b79e-6192f844cf84/2/0 | FF3 | FF3 KEY | null | updateLinkType | Used to update a single link type. All fields that are not submitted will be cleared (set to NULL). The model will tell you which fields are mandatory. You cannot update some of the system provided link types, indicated by the editable=false flag when you list it. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/8d520c62-82ef-420b-8ed4-0dbcb56a8348/1/0 | FF3 | FF3 KEY | null | storeLinkType | Creates a new link type. The data required can be submitted as a JSON body or as a list of parameters (in key=value pairs, like a webform). | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/20ab70a3-8020-4516-82f4-5285fda54e68/0/0 | FF3 | FF3 KEY | null | getCurrenciesAC | 200 | null | [{"id": "2", "name": "Currency name", "code": "EUR", "symbol": "$", "decimal_places": 2}] | {"type": "array", "items": {"type": "object", "required": ["id", "name", "code", "symbol", "decimal_places"], "properties": {"id": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string", "description": "Currency name."}, "code": {"type": "string", "format": "string", "description": "Currency code."}, "symbol": {"type": "string", "format": "string"}, "decimal_places": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/62e1f383-890f-4c4f-a309-fd441546826f/0/0 | FF3 | FF3 KEY | null | updateTransactionLink | Used to update a single existing link. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/d009f2fd-6f4b-499e-be85-9fa58ce8a39f/1/0 | FF3 | FF3 KEY | null | storeTransactionLink | Store a new link between two transactions. For this end point you need the journal_id from a transaction. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/d7f27e8c-4425-479b-81a9-4beab53f5f95/0/0 | FF3 | FF3 KEY | null | getBudgetsAC | 200 | null | [{"id": "2", "name": "Groceries"}] | {"type": "array", "items": {"type": "object", "required": ["id", "name"], "properties": {"id": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string", "description": "Name of the budget found by an auto-complete search."}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/ccd9226e-7582-407d-8f23-91903e832a27/0/0 | FF3 | FF3 KEY | null | getTagAC | 200 | null | [{"id": "2", "name": "too-expensive-tag-example", "tag": "too-expensive-tag-example"}] | {"type": "array", "items": {"type": "object", "required": ["id", "name", "tag"], "properties": {"id": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string", "description": "Name of the tag found by an auto-complete search."}, "tag": {"type": "string", "format": "string", "description": "Name of the tag found by an auto-complete search."}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/757dda8f-33ec-4302-8e23-283dc02d7aa8/0/0 | FF3 | FF3 KEY | null | getPiggiesAC | 200 | null | [{"id": "2", "name": "New couch", "currency_id": "12", "currency_code": "EUR", "currency_symbol": "$", "currency_name": "Euro", "currency_decimal_places": 2, "object_group_id": "5", "object_group_title": "Example Group"}] | {"type": "array", "items": {"type": "object", "required": ["id", "name"], "properties": {"id": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string", "description": "Name of the piggy bank found by an auto-complete search."}, "currency_id": {"type": "string", "format": "string", "description": "Currency ID for this piggy bank."}, "currency_code": {"type": "string", "format": "string", "description": "Currency code for this piggy bank."}, "currency_symbol": {"type": "string", "format": "string"}, "currency_name": {"type": "string", "format": "string", "description": "Currency name for the currency used by this account."}, "currency_decimal_places": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "object_group_id": {"type": ["string", "null"], "format": "string", "description": "The group ID of the group this object is part of. NULL if no group."}, "object_group_title": {"type": ["string", "null"], "format": "string", "description": "The name of the group. NULL if no group."}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/dad53c63-35f5-4d62-a3da-0ff222be16d4/0/0 | FF3 | FF3 KEY | null | getCron | Firefly III has one endpoint for its various cron related tasks. Send a GET to this endpoint
to run the cron. The cron requires the CLI token to be present. The cron job will fire for all
users. | 200 | null | {"recurring_transactions": {"job_fired": true, "job_succeeded": true, "job_errored": true, "message": "Cron result message"}, "auto_budgets": {"job_fired": true, "job_succeeded": true, "job_errored": true, "message": "Cron result message"}, "telemetry": {"job_fired": true, "job_succeeded": true, "job_errored": true, "message": "Cron result message"}} | {"type": "object", "properties": {"recurring_transactions": {"type": "object", "properties": {"job_fired": {"type": ["boolean", "null"], "format": "boolean", "description": "This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs\nonly fire every 24 hours, for example.\n"}, "job_succeeded": {"type": ["boolean", "null"], "format": "boolean", "description": "This value tells you if this specific cron job actually did something. The job may fire but not\nchange anything.\n"}, "job_errored": {"type": ["boolean", "null"], "format": "boolean", "description": "If the cron job ran into some kind of an error, this value will be true."}, "message": {"type": ["string", "null"], "format": "string", "description": "If the cron job ran into some kind of an error, this value will be the error message. The success message\nif the job actually ran OK.\n"}}}, "auto_budgets": {"type": "object", "properties": {"job_fired": {"type": ["boolean", "null"], "format": "boolean", "description": "This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs\nonly fire every 24 hours, for example.\n"}, "job_succeeded": {"type": ["boolean", "null"], "format": "boolean", "description": "This value tells you if this specific cron job actually did something. The job may fire but not\nchange anything.\n"}, "job_errored": {"type": ["boolean", "null"], "format": "boolean", "description": "If the cron job ran into some kind of an error, this value will be true."}, "message": {"type": ["string", "null"], "format": "string", "description": "If the cron job ran into some kind of an error, this value will be the error message. The success message\nif the job actually ran OK.\n"}}}, "telemetry": {"type": "object", "properties": {"job_fired": {"type": ["boolean", "null"], "format": "boolean", "description": "This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs\nonly fire every 24 hours, for example.\n"}, "job_succeeded": {"type": ["boolean", "null"], "format": "boolean", "description": "This value tells you if this specific cron job actually did something. The job may fire but not\nchange anything.\n"}, "job_errored": {"type": ["boolean", "null"], "format": "boolean", "description": "If the cron job ran into some kind of an error, this value will be true."}, "message": {"type": ["string", "null"], "format": "string", "description": "If the cron job ran into some kind of an error, this value will be the error message. The success message\nif the job actually ran OK.\n"}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/c97e4869-22b2-444b-b50f-1443095859f4/0/0 | FF3 | FF3 KEY | null | getConfiguration | Returns all editable and not-editable configuration values for this Firefly III installation | 200 | null | [{"title": "configuration.is_demo_site", "value": true, "editable": true}] | {"type": "array", "items": {"type": "object", "required": ["title", "value", "editable"], "properties": {"title": {"type": "string", "enum": ["configuration.is_demo_site", "configuration.permission_update_check", "configuration.last_update_check", "configuration.single_user_mode", "firefly.version", "firefly.api_version", "firefly.default_location", "firefly.account_to_transaction", "firefly.allowed_opposing_types", "firefly.accountRoles", "firefly.valid_liabilities", "firefly.interest_periods", "firefly.enable_external_map", "firefly.expected_source_types", "app.timezone", "firefly.bill_periods", "firefly.credit_card_types", "firefly.languages", "firefly.valid_view_ranges"]}, "value": {"oneOf": [{"type": "boolean"}, {"type": "string"}, {"type": "object"}, {"type": "array", "items": {"type": "string", "format": "string"}}]}, "editable": {"type": "boolean", "format": "boolean", "description": "If this config variable can be edited by the user"}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/17f7c4d7-3ced-47a0-a087-d69ac7fb239f/1/0 | FF3 | FF3 KEY | null | storeTransaction | Creates a new transaction. The data required can be submitted as a JSON body or as a list of parameters. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/a1cb6a77-6f96-4b42-b9f3-c681e89b14f9/0/0 | FF3 | FF3 KEY | null | updateTransaction | Update an existing transaction. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/f38c454e-66a0-4ab7-833a-e73562be18dc/0/0 | FF3 | FF3 KEY | null | updateCurrency | Update existing currency. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/f38c454e-66a0-4ab7-833a-e73562be18dc/1/0 | FF3 | FF3 KEY | null | updateCurrency | Update existing currency. | 200 | null | {"data": {"type": "currencies", "id": "2", "attributes": {"created_at": "2018-09-17T12:46:47+01:00", "updated_at": "2018-09-17T12:46:47+01:00", "enabled": true, "default": true, "code": "AMS", "name": "Ankh-Morpork dollar", "symbol": "AM$", "decimal_places": 2}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["type", "id", "attributes"], "properties": {"type": {"type": "string", "format": "string", "description": "Immutable value"}, "id": {"type": "string", "format": "string"}, "attributes": {"type": "object", "required": ["code", "name", "symbol"], "properties": {"created_at": {"type": "string", "format": "date-time"}, "updated_at": {"type": "string", "format": "date-time"}, "enabled": {"type": "boolean", "format": "boolean", "default": true, "description": "Defaults to true"}, "default": {"type": "boolean", "format": "boolean", "description": "Make this currency the default currency."}, "code": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string"}, "symbol": {"type": "string", "format": "string"}, "decimal_places": {"type": "integer", "format": "int32", "description": "Supports 0-16 decimals.", "minimum": -2147483648, "maximum": 2147483647}}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/0da982ac-6df9-4b08-bbcf-4ae000a9dc20/0/0 | FF3 | FF3 KEY | null | storeCurrency | Creates a new currency. The data required can be submitted as a JSON body or as a list of parameters. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/87f62c82-d025-41e0-a533-827d0b774352/0/0 | FF3 | FF3 KEY | null | storeRuleGroup | Creates a new rule group. The data required can be submitted as a JSON body or as a list of parameters. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/9c2b9050-8e0b-41d1-8ae8-7d58821a9175/0/0 | FF3 | FF3 KEY | null | getDefaultCurrency | Get the user's default currency. | 200 | null | {"data": {"type": "currencies", "id": "2", "attributes": {"created_at": "2018-09-17T12:46:47+01:00", "updated_at": "2018-09-17T12:46:47+01:00", "enabled": true, "default": true, "code": "AMS", "name": "Ankh-Morpork dollar", "symbol": "AM$", "decimal_places": 2}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["type", "id", "attributes"], "properties": {"type": {"type": "string", "format": "string", "description": "Immutable value"}, "id": {"type": "string", "format": "string"}, "attributes": {"type": "object", "required": ["code", "name", "symbol"], "properties": {"created_at": {"type": "string", "format": "date-time"}, "updated_at": {"type": "string", "format": "date-time"}, "enabled": {"type": "boolean", "format": "boolean", "default": true, "description": "Defaults to true"}, "default": {"type": "boolean", "format": "boolean", "description": "Make this currency the default currency."}, "code": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string"}, "symbol": {"type": "string", "format": "string"}, "decimal_places": {"type": "integer", "format": "int32", "description": "Supports 0-16 decimals.", "minimum": -2147483648, "maximum": 2147483647}}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/6cc49e5f-1cfc-4b25-8b22-b92d415d7593/0/0 | FF3 | FF3 KEY | null | storeWebhook | Creates a new webhook. The data required can be submitted as a JSON body or as a list of parameters. The webhook will be given a random secret. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/08bdb702-7f86-4a14-b89d-4029b99e1734/0/0 | FF3 | FF3 KEY | null | getTransactionTypesAC | 200 | null | [{"id": "2", "name": "Withdrawal", "type": "Withdrawal"}] | {"type": "array", "items": {"type": "object", "required": ["id", "name", "type"], "properties": {"id": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string", "description": "Type of the object found by an auto-complete search."}, "type": {"type": "string", "format": "string", "description": "Name of the object found by an auto-complete search."}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/ec15b127-c1d8-49c1-9b88-5b9d9271fd26/0/0 | FF3 | FF3 KEY | null | insightTransferNoTag | This endpoint gives a summary of the transfers made by the user, including only transfers with no tag. | 200 | null | [{"difference": "123.45", "difference_float": 123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"difference": {"type": "string", "format": "string", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this expense account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this expense account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/f433e558-c0b3-4bf3-b956-e1909614d56d/0/0 | FF3 | FF3 KEY | null | getObjectGroupsAC | 200 | null | [{"id": "2", "title": "Object Group one", "name": "Object Group one"}] | {"type": "array", "items": {"type": "object", "required": ["id", "title", "name"], "properties": {"id": {"type": "string", "format": "string"}, "title": {"type": "string", "format": "string", "description": "Title of the object group found by an auto-complete search."}, "name": {"type": "string", "format": "string", "description": "Title of the object group found by an auto-complete search."}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/d1d42da1-abbd-4f85-9653-f56e9414aa03/0/0 | FF3 | FF3 KEY | null | insightIncomeRevenue | This endpoint gives a summary of the income received by the user, grouped by revenue account. | 200 | null | [{"id": "123", "name": "Land lord", "difference": "-123.45", "difference_float": -123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "string", "description": "This ID is a reference to the original object."}, "name": {"type": "string", "format": "string", "description": "This is the name of the object."}, "difference": {"type": "string", "format": "string", "description": "The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/b4145cc2-4030-4456-9229-46d92eccd23e/0/0 | FF3 | FF3 KEY | null | storeBill | Creates a new bill. The data required can be submitted as a JSON body or as a list of parameters. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/2e35a620-4e7e-4c06-859f-57502eba6ae4/1/0 | FF3 | FF3 KEY | null | updateAccount | Used to update a single account. All fields that are not submitted will be cleared (set to NULL). The model will tell you which fields are mandatory. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/29601377-8945-495f-8aa9-9e2e6c13ab2d/0/0 | FF3 | FF3 KEY | null | insightExpenseNoTag | This endpoint gives a summary of the expenses made by the user, including only expenses with no tag. | 200 | null | [{"difference": "123.45", "difference_float": 123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"difference": {"type": "string", "format": "string", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this expense account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this expense account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/80ab83d7-520b-4396-ba0e-0bc1076b6e7d/0/0 | FF3 | FF3 KEY | null | updateRuleGroup | Update existing rule group. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/d15b8a4e-dc42-4009-bc9a-2b5913d51176/0/0 | FF3 | FF3 KEY | null | insightIncomeAsset | This endpoint gives a summary of the income received by the user, grouped by asset account. | 200 | null | [{"id": "123", "name": "Land lord", "difference": "-123.45", "difference_float": -123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "string", "description": "This ID is a reference to the original object."}, "name": {"type": "string", "format": "string", "description": "This is the name of the object."}, "difference": {"type": "string", "format": "string", "description": "The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/eb6b1682-70f0-4fb0-8b40-a5fb48ec8192/0/0 | FF3 | FF3 KEY | null | insightTransferTag | This endpoint gives a summary of the transfers created by the user, grouped by (any) tag. | 200 | null | [{"id": "123", "name": "Land lord", "difference": "-123.45", "difference_float": -123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "string", "description": "This ID is a reference to the original object."}, "name": {"type": "string", "format": "string", "description": "This is the name of the object."}, "difference": {"type": "string", "format": "string", "description": "The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/d8b42ec8-9d7b-4264-a5d2-bb1a0430b9b7/0/0 | FF3 | FF3 KEY | null | updateWebhook | Update an existing webhook's information. If you wish to reset the secret, submit any value as the "secret". Firefly III will take this as a hint and reset the secret of the webhook. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/c6e3a7a0-8a78-4080-8feb-b56c674a7fe8/0/0 | FF3 | FF3 KEY | null | insightExpenseNoBudget | This endpoint gives a summary of the expenses made by the user, including only expenses with no budget. | 200 | null | [{"difference": "123.45", "difference_float": 123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"difference": {"type": "string", "format": "string", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this expense account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this expense account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/3ba852e2-33a9-4b54-afaa-1fbae5346b4b/0/0 | FF3 | FF3 KEY | null | storeAccount | Creates a new account. The data required can be submitted as a JSON body or as a list of parameters (in key=value pairs, like a webform). | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/eb1d0aa0-045a-4a0e-b1e3-bf449a15ee27/0/0 | FF3 | FF3 KEY | null | getCategoriesAC | 200 | null | [{"id": "2", "name": "Category X"}] | {"type": "array", "items": {"type": "object", "required": ["id", "name"], "properties": {"id": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string", "description": "Name of the category found by an auto-complete search."}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/617ebdea-b9c8-4cf9-a609-f51549d25c0e/0/0 | FF3 | FF3 KEY | null | getTransactionsIDAC | 200 | null | [{"id": "2", "transaction_group_id": "2", "name": "#12: Transaction", "description": "#12: Transaction"}] | {"type": "array", "items": {"type": "object", "required": ["id", "name", "description"], "properties": {"id": {"type": "string", "format": "string", "description": "The ID of a transaction journal (basically a single split)."}, "transaction_group_id": {"type": "string", "format": "string", "description": "The ID of the underlying transaction group."}, "name": {"type": "string", "format": "string", "description": "Transaction description with ID in the name."}, "description": {"type": "string", "format": "string", "description": "Transaction description with ID in the name."}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/3c9f3787-0ab6-437f-acad-01d83c755b52/0/0 | FF3 | FF3 KEY | null | insightExpenseExpense | This endpoint gives a summary of the expenses made by the user, grouped by expense account. | 200 | null | [{"id": "123", "name": "Land lord", "difference": "-123.45", "difference_float": -123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "string", "description": "This ID is a reference to the original object."}, "name": {"type": "string", "format": "string", "description": "This is the name of the object."}, "difference": {"type": "string", "format": "string", "description": "The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/d71367bc-3fb8-4234-9bb9-1a3ef1c4382c/0/0 | FF3 | FF3 KEY | null | insightTransferNoCategory | This endpoint gives a summary of the transfers made by the user, including only transfers with no category. | 200 | null | [{"difference": "123.45", "difference_float": 123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"difference": {"type": "string", "format": "string", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this expense account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this expense account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/80e6e36d-e751-4625-b086-3baed5b2ce0f/0/0 | FF3 | FF3 KEY | null | insightTransferCategory | This endpoint gives a summary of the transfers made by the user, grouped by (any) category. | 200 | null | [{"id": "123", "name": "Land lord", "difference": "-123.45", "difference_float": -123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "string", "description": "This ID is a reference to the original object."}, "name": {"type": "string", "format": "string", "description": "This is the name of the object."}, "difference": {"type": "string", "format": "string", "description": "The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/be76c1b5-c2ea-48cd-8a70-55c322c30114/0/0 | FF3 | FF3 KEY | null | insightIncomeNoCategory | This endpoint gives a summary of the income received by the user, including only income with no category. | 200 | null | [{"difference": "123.45", "difference_float": 123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"difference": {"type": "string", "format": "string", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this expense account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this expense account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/b66cb918-381b-43be-b816-2b37a8dccdb5/0/0 | FF3 | FF3 KEY | null | getChartAccountOverview | This endpoint returns the data required to generate a chart with basic asset account balance information. | 200 | null | [{"label": "Checking account", "currency_id": "5", "currency_code": "EUR", "currency_symbol": "$", "currency_decimal_places": 2, "start_date": "2018-09-17T12:46:47+01:00", "end_date": "2018-09-17T12:46:47+01:00", "type": "line", "yAxisID": 0, "entries": {}}] | {"type": "array", "items": {"type": "object", "properties": {"label": {"type": "string", "format": "string", "description": "This is the title of the current set. It can refer to an account, a budget or another object (by name)."}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the currency associated to the data in the entries."}, "currency_code": {"type": "string", "format": "string"}, "currency_symbol": {"type": "string", "format": "string"}, "currency_decimal_places": {"type": "integer", "format": "int32", "description": "Number of decimals for the currency associated to the data in the entries.", "minimum": -2147483648, "maximum": 2147483647}, "start_date": {"type": "string", "format": "date-time"}, "end_date": {"type": "string", "format": "date-time"}, "type": {"type": "string", "format": "string", "description": "Indicated the type of chart that is expected to be rendered. You can safely ignore this if you want."}, "yAxisID": {"type": "integer", "format": "int32", "description": "Used to indicate the Y axis for this data set. Is usually between 0 and 1 (left and right side of the chart).", "minimum": -2147483648, "maximum": 2147483647}, "entries": {"type": "object", "description": "The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value.", "items": {"type": "object", "properties": {"key": {"type": "string", "format": "string", "description": "The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123."}}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/13e3e9a0-a9a1-4582-8117-a4281ddf651e/0/0 | FF3 | FF3 KEY | null | insightIncomeTag | This endpoint gives a summary of the income received by the user, grouped by (any) tag. | 200 | null | [{"id": "123", "name": "Land lord", "difference": "-123.45", "difference_float": -123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "string", "description": "This ID is a reference to the original object."}, "name": {"type": "string", "format": "string", "description": "This is the name of the object."}, "difference": {"type": "string", "format": "string", "description": "The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/262e4214-bf25-4d0b-beb0-9239a8f393d2/0/0 | FF3 | FF3 KEY | null | insightIncomeCategory | This endpoint gives a summary of the income received by the user, grouped by (any) category. | 200 | null | [{"id": "123", "name": "Land lord", "difference": "-123.45", "difference_float": -123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "string", "description": "This ID is a reference to the original object."}, "name": {"type": "string", "format": "string", "description": "This is the name of the object."}, "difference": {"type": "string", "format": "string", "description": "The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/30207ab3-154d-4928-a0a6-2a1c4f105c57/0/0 | FF3 | FF3 KEY | null | getRuleGroupsAC | 200 | null | [{"id": "2", "name": "Rule group one", "description": "Some rule group."}] | {"type": "array", "items": {"type": "object", "required": ["id", "name"], "properties": {"id": {"type": "string", "format": "string"}, "name": {"type": "string", "format": "string", "description": "Name of the rule group found by an auto-complete search."}, "description": {"type": "string", "format": "string", "description": "Description of the rule group found by auto-complete."}}}} |
|
0f1ff2dd-bf4c-414b-821c-25212225c10e/5d4eefca-52fd-4705-bcf3-fa7a36dd3259/1/0 | FF3 | FF3 KEY | null | updateBudget | Update existing budget. This endpoint cannot be used to set budget amount limits. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/c9f7f49a-baee-45be-9509-c74d2c1775ea/0/0 | FF3 | FF3 KEY | null | insightIncomeNoTag | This endpoint gives a summary of the income received by the user, including only income with no tag. | 200 | null | [{"difference": "123.45", "difference_float": 123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"difference": {"type": "string", "format": "string", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this expense account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this expense account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/9a152a53-652d-4844-a582-0d23ccf31ff6/0/0 | FF3 | FF3 KEY | null | insightExpenseTotal | This endpoint gives a sum of the total expenses made by the user. | 200 | null | [{"difference": "123.45", "difference_float": 123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"difference": {"type": "string", "format": "string", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this expense account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this expense account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/1750a856-5a7d-467f-ad7e-edba8225bf15/0/0 | FF3 | FF3 KEY | null | insightTransferTotal | This endpoint gives a sum of the total amount transfers made by the user. | 200 | null | [{"difference": "123.45", "difference_float": 123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"difference": {"type": "string", "format": "string", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this expense account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this expense account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/1bfa3365-a0ef-4598-a5cb-b34e1c8864cc/0/0 | FF3 | FF3 KEY | null | storeAvailableBudget | Creates a new available budget for a specified period. The data required can be submitted as a JSON body or as a list of parameters. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/664b0907-6051-4459-bca7-14ebcc0bc7bc/0/0 | FF3 | FF3 KEY | null | insightExpenseBill | This endpoint gives a summary of the expenses made by the user, grouped by (any) bill. | 200 | null | [{"id": "123", "name": "Land lord", "difference": "-123.45", "difference_float": -123.45, "currency_id": "5", "currency_code": "EUR"}] | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "string", "description": "This ID is a reference to the original object."}, "name": {"type": "string", "format": "string", "description": "This is the name of the object."}, "difference": {"type": "string", "format": "string", "description": "The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts."}, "difference_float": {"type": "number", "format": "double", "description": "The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "currency_id": {"type": "string", "format": "string", "description": "The currency ID of the expenses listed for this account."}, "currency_code": {"type": "string", "format": "string", "description": "The currency code of the expenses listed for this account."}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/d564c6e7-8493-4487-9818-f9c8411f96d7/0/0 | FF3 | FF3 KEY | null | storeUser | Creates a new user. The data required can be submitted as a JSON body or as a list of parameters. The user will be given a random password, which they can reset using the "forgot password" function. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/66b32d12-0d8a-46b9-88b3-e5f9f3708c13/0/0 | FF3 | FF3 KEY | null | updatePreference | Update a user's preference. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/113cb847-54bf-4c16-a0af-76c7deabe2ff/1/0 | FF3 | FF3 KEY | null | updateRecurrence | Update existing recurring transaction. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/59bf4c4c-d72f-4ebe-a383-1af487b07905/0/0 | FF3 | FF3 KEY | null | updateUser | Update existing user. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/602c3ae2-d4d4-4c90-86dc-aae3acef21d8/1/0 | FF3 | FF3 KEY | null | storePreference | This endpoint creates a new preference. The name and data are free-format, and entirely up to you. If the preference is not used in Firefly III itself it may not be configurable through the user interface, but you can use this endpoint to persist custom data for your own app. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/8d1416c8-0fb0-4d77-9d3f-2e1a6daedffc/0/0 | FF3 | FF3 KEY | null | getSingleConfiguration | Returns one configuration variable for this Firefly III installation | 200 | null | {"data": {"title": "configuration.is_demo_site", "value": true, "editable": true}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["title", "value", "editable"], "properties": {"title": {"type": "string", "enum": ["configuration.is_demo_site", "configuration.permission_update_check", "configuration.last_update_check", "configuration.single_user_mode", "firefly.version", "firefly.api_version", "firefly.default_location", "firefly.account_to_transaction", "firefly.allowed_opposing_types", "firefly.accountRoles", "firefly.valid_liabilities", "firefly.interest_periods", "firefly.enable_external_map", "firefly.expected_source_types", "app.timezone", "firefly.bill_periods", "firefly.credit_card_types", "firefly.languages", "firefly.valid_view_ranges"]}, "value": {"oneOf": [{"type": "boolean"}, {"type": "string"}, {"type": "object"}, {"type": "array", "items": {"type": "string", "format": "string"}}]}, "editable": {"type": "boolean", "format": "boolean", "description": "If this config variable can be edited by the user"}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/86ee8576-56a4-477c-bb7f-ea5a09e856dc/0/0 | FF3 | FF3 KEY | null | setConfiguration | Set a single configuration value. Not all configuration values can be updated so the list of accepted configuration variables is small. | 200 | null | {"data": {"title": "configuration.is_demo_site", "value": true, "editable": true}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["title", "value", "editable"], "properties": {"title": {"type": "string", "enum": ["configuration.is_demo_site", "configuration.permission_update_check", "configuration.last_update_check", "configuration.single_user_mode", "firefly.version", "firefly.api_version", "firefly.default_location", "firefly.account_to_transaction", "firefly.allowed_opposing_types", "firefly.accountRoles", "firefly.valid_liabilities", "firefly.interest_periods", "firefly.enable_external_map", "firefly.expected_source_types", "app.timezone", "firefly.bill_periods", "firefly.credit_card_types", "firefly.languages", "firefly.valid_view_ranges"]}, "value": {"oneOf": [{"type": "boolean"}, {"type": "string"}, {"type": "object"}, {"type": "array", "items": {"type": "string", "format": "string"}}]}, "editable": {"type": "boolean", "format": "boolean", "description": "If this config variable can be edited by the user"}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/86ee8576-56a4-477c-bb7f-ea5a09e856dc/1/0 | FF3 | FF3 KEY | null | setConfiguration | Set a single configuration value. Not all configuration values can be updated so the list of accepted configuration variables is small. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/79c7c021-6fd8-4f5c-9e62-d7a05888bdc3/1/0 | FF3 | FF3 KEY | null | updateRule | Update existing rule. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/dd734cd3-6fc3-4d66-8ebc-db52beab2348/1/0 | FF3 | FF3 KEY | null | updateCategory | Update existing category. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/bf968e63-6d3d-45df-a630-2089a3f49768/1/0 | FF3 | FF3 KEY | null | storeRecurrence | Creates a new recurring transaction. The data required can be submitted as a JSON body or as a list of parameters. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/f17c1365-bf07-46a5-9091-2086fb64c287/1/0 | FF3 | FF3 KEY | null | storeCategory | Creates a new category. The data required can be submitted as a JSON body or as a list of parameters. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
0f1ff2dd-bf4c-414b-821c-25212225c10e/45dfd7d7-accc-4c87-816d-31307dc8cf5f/1/0 | FF3 | FF3 KEY | null | storeRule | Creates a new rule. The data required can be submitted as a JSON body or as a list of parameters. | 422 | null | {"message": "The given data was invalid.", "errors": {"field1": [], "field2": []}} | {"type": "object", "properties": {"message": {"type": "string", "format": "string"}, "errors": {"type": "object", "properties": {"field1": {"type": "array", "items": {"type": "string", "format": "string"}}, "field2": {"type": "array", "items": {"type": "string", "format": "string"}}}}}} |
a5d6bc12-2de8-4cee-831b-ea7ece6d4e02/95c1b5fb-d203-4dca-a4ee-7da88d2d57b6/0/0 | EZ-ContactManager | Short ability to send and retrieve data from your EZ-ContactManager Account | null | Customer Add | Add a customer | 200 | New Customer | {"firstname": "Johnny", "lastname": "Dough", "email": "[email protected]", "accountid": 1, "created": "2022-06-07T22:39:29", "id": 9713, "fullname": "Johnny Dough"} | {"type": "object", "properties": {"firstname": {"type": "string"}, "lastname": {"type": "string"}, "email": {"type": "string"}, "accountid": {"type": "integer"}, "created": {"type": "string"}, "id": {"type": "integer"}, "fullname": {"type": "string"}}} |
2f7c266e-e82e-4044-9851-63d1f013b16b/a6f0e888-a051-4a85-ad82-d39510c38eeb/0/0 | Autonix | Autonix.io provides robust visitor analytics and contactless check-in tools. | null | All Locations | List all locations associated with this account. | 200 | Response | {"data": [{"id": 4, "slug": "jack-rabbit-slims", "user_id": 3, "name": "Jack Rabbit Slims", "website_url": "https://autonix.io", "email": "[email protected]", "phone": "+19492120000", "sms_phone": "+18445020551", "address": "Santa Monica Boulevard", "address_line_2": "", "city": "Los Angeles", "state": "California", "zip": "90212", "country": "US", "timezone": "America/Los_Angeles", "allow_skip": 0, "custom_message": "", "thankyou_message": "", "instruction_message": "", "photo": "https://autonix-storage-prod.s3.amazonaws.com/location_photo/TlxULy7B2jPHJUAPWJOIKFzQbVhehySHsdbVjxHH.png", "url_after_submit": "", "sms_thankyou_message": 0, "deleted_at": "", "visit_url": "https://autonix.io/v/jack-rabbit-slims", "tablet_url": "https://autonix.io/tablet/jack-rabbit-slims", "name_checkin": "enabled", "email_checkin": "enabled", "phone_checkin": "enabled", "sms_id": "PN33a50e1c907decc46e6b7f382bdbafe0", "sms_receive_field": "name"}, {"id": 1, "slug": "la-ratatouille", "user_id": 3, "name": "La Ratatouille", "website_url": "https://disney.fandom.com/wiki/La_Ratatouille", "email": "[email protected]", "phone": "+12125555554", "sms_phone": "+18444860664", "address": "123 Test Street", "address_line_2": "", "city": "Philadelphia", "state": "PA", "zip": "12343", "country": "US", "timezone": "America/Detroit", "allow_skip": 0, "custom_message": "", "thankyou_message": "Remy welcomes you to La Ratatouille.", "instruction_message": "", "photo": "https://autonix-storage-prod.s3.amazonaws.com/location_photo/s2yiVjZj3o8wcMNfthNT4tp0S4ATt0FePrGwnVeX.png", "url_after_submit": "https://share.getcloudapp.com/4gu1pLvv", "sms_thankyou_message": 1, "deleted_at": "", "visit_url": "https://autonix.io/v/la-ratatouille", "tablet_url": "https://autonix.io/tablet/la-ratatouille", "name_checkin": "enabled", "email_checkin": "enabled", "phone_checkin": "enabled", "sms_id": "PNa68e85af4b6c656df4674fe9983385d5", "sms_receive_field": "name"}, {"id": 10002, "slug": "palm-restaurant", "user_id": 3, "name": "Palm Restaurant", "website_url": "https://palmrestaurant.com", "email": "[email protected]", "phone": "+19492125580", "sms_phone": "+18337665186", "address": "Flower Street", "address_line_2": "", "city": "Los Angeles", "state": "California", "zip": "90015", "country": "US", "timezone": "America/Los_Angeles", "allow_skip": 0, "custom_message": "Welcome to the Palm Restaurant. Please check-in. Visit this same page to check-out when you leave!", "thankyou_message": "Welcome. You're on your way to being part of the club. Click continue to see our menu", "instruction_message": "", "photo": "https://autonix-storage-prod.s3.amazonaws.com/location_photo/WlEjfgI5aZzZpJtmrQGmxMRE713Nci99vZBZZhZu.png", "url_after_submit": "https://www.thepalm.com/location/the-palm-los-angeles/#menus", "sms_thankyou_message": 1, "deleted_at": "", "visit_url": "https://autonix.io/v/palm-restaurant", "tablet_url": "https://autonix.io/tablet/palm-restaurant", "name_checkin": "enabled", "email_checkin": "required", "phone_checkin": "required", "sms_id": "PN0a3717425222e7cda8f2c3590f3c7f6b", "sms_receive_field": "name"}]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"data": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer"}, "slug": {"type": "string"}, "user_id": {"type": "integer"}, "name": {"type": "string"}, "website_url": {"type": "string"}, "email": {"type": "string"}, "phone": {"type": "string"}, "sms_phone": {"type": "string"}, "address": {"type": "string"}, "address_line_2": {"type": "string"}, "city": {"type": "string"}, "state": {"type": "string"}, "zip": {"type": "string"}, "country": {"type": "string"}, "timezone": {"type": "string"}, "allow_skip": {"type": "integer"}, "custom_message": {"type": "string"}, "thankyou_message": {"type": "string"}, "instruction_message": {"type": "string"}, "photo": {"type": "string"}, "url_after_submit": {"type": "string"}, "sms_thankyou_message": {"type": "integer"}, "deleted_at": {"type": "string"}, "visit_url": {"type": "string"}, "tablet_url": {"type": "string"}, "name_checkin": {"type": "string"}, "email_checkin": {"type": "string"}, "phone_checkin": {"type": "string"}, "sms_id": {"type": "string"}, "sms_receive_field": {"type": "string"}}, "required": ["address", "address_line_2", "allow_skip", "city", "country", "custom_message", "deleted_at", "email", "email_checkin", "id", "instruction_message", "name", "name_checkin", "phone", "phone_checkin", "photo", "slug", "sms_id", "sms_phone", "sms_receive_field", "sms_thankyou_message", "state", "tablet_url", "thankyou_message", "timezone", "url_after_submit", "user_id", "visit_url", "website_url", "zip"]}}}, "required": ["data"]} |
2f7c266e-e82e-4044-9851-63d1f013b16b/38ed4c3d-208e-44dc-9b0e-9a13ee86d7eb/0/0 | Autonix | Autonix.io provides robust visitor analytics and contactless check-in tools. | null | Visits by Location | This API gets all the visits, including visitor data, by location. Location ID is required (available on each location here: https://autonix.io/locations | 200 | Response | {"data": [{"id": 10002, "visitor_id": 10000, "location_id": 4, "type": "url", "visit_start": "2021-03-12T15:54:04.000000Z", "visit_end": null, "phone": "+12129632587", "name": "new sequence", "email": "[email protected]", "location_name": "Jack Rabbit Slims", "checkin": "1 month ago", "checkout": null, "allow_contact": 1}, {"id": 10001, "visitor_id": 7, "location_id": 4, "type": "url", "visit_start": "2021-03-12T15:50:09.000000Z", "visit_end": null, "phone": "+12129876548", "name": "testing sequence", "email": "[email protected]", "location_name": "Jack Rabbit Slims", "checkin": "1 month ago", "checkout": null, "allow_contact": 1}, {"id": 10, "visitor_id": 3, "location_id": 4, "type": "url", "visit_start": "2021-03-11T00:12:05.000000Z", "visit_end": null, "phone": "+16318728233", "name": "Scott Teger", "email": "[email protected]", "location_name": "Jack Rabbit Slims", "checkin": "1 month ago", "checkout": null, "allow_contact": 1}], "links": {"first": "https://autonix.io/api/visits/location/4?page=1", "last": "https://autonix.io/api/visits/location/4?page=1", "prev": null, "next": null}, "meta": {"current_page": 1, "from": 1, "last_page": 1, "links": [{"url": null, "label": "« Previous", "active": false}, {"url": "https://autonix.io/api/visits/location/4?page=1", "label": "1", "active": true}, {"url": null, "label": "Next »", "active": false}], "path": "https://autonix.io/api/visits/location/4", "per_page": 25, "to": 3, "total": 3}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"data": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer"}, "visitor_id": {"type": "integer"}, "location_id": {"type": "integer"}, "type": {"type": "string"}, "visit_start": {"type": "string"}, "visit_end": {"type": "null"}, "phone": {"type": "string"}, "name": {"type": "string"}, "email": {"type": "string"}, "location_name": {"type": "string"}, "checkin": {"type": "string"}, "checkout": {"type": "null"}, "allow_contact": {"type": "integer"}}, "required": ["allow_contact", "checkin", "checkout", "email", "id", "location_id", "location_name", "name", "phone", "type", "visit_end", "visit_start", "visitor_id"]}}, "links": {"type": "object", "properties": {"first": {"type": "string"}, "last": {"type": "string"}, "prev": {"type": "null"}, "next": {"type": "null"}}, "required": ["first", "last", "next", "prev"]}, "meta": {"type": "object", "properties": {"current_page": {"type": "integer"}, "from": {"type": "integer"}, "last_page": {"type": "integer"}, "links": {"type": "array", "items": {"type": "object", "properties": {"url": {"type": ["null", "string"]}, "label": {"type": "string"}, "active": {"type": "boolean"}}, "required": ["active", "label", "url"]}}, "path": {"type": "string"}, "per_page": {"type": "integer"}, "to": {"type": "integer"}, "total": {"type": "integer"}}, "required": ["current_page", "from", "last_page", "links", "path", "per_page", "to", "total"]}}, "required": ["data", "links", "meta"]} |
2f7c266e-e82e-4044-9851-63d1f013b16b/67510b94-fa6d-4878-9344-9a8f715600e4/0/0 | Autonix | Autonix.io provides robust visitor analytics and contactless check-in tools. | null | Check Usage | Monitor your usage of Autonix with this Check Usage endpoint. Includes usage by check-in type as well as any purchased Add-ons. | 200 | Response | {"checkinThisMonth": {"sms": 0, "url": 0, "total": 0}, "checkinAllTime": {"sms": 2, "url": 11, "total": 13}, "location": 3, "locationAllTime": 4, "smsAddOnsRemaining": 0, "smsAddOnsBuyed": 0, "totalSmsVisitsPlan": 1500, "totalUrlVisitsPlan": 5000, "totalLocationsPlan": 3} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"checkinThisMonth": {"type": "object", "properties": {"sms": {"type": "integer"}, "url": {"type": "integer"}, "total": {"type": "integer"}}, "required": ["sms", "total", "url"]}, "checkinAllTime": {"type": "object", "properties": {"sms": {"type": "integer"}, "url": {"type": "integer"}, "total": {"type": "integer"}}, "required": ["sms", "total", "url"]}, "location": {"type": "integer"}, "locationAllTime": {"type": "integer"}, "smsAddOnsRemaining": {"type": "integer"}, "smsAddOnsBuyed": {"type": "integer"}, "totalSmsVisitsPlan": {"type": "integer"}, "totalUrlVisitsPlan": {"type": "integer"}, "totalLocationsPlan": {"type": "integer"}}, "required": ["checkinAllTime", "checkinThisMonth", "location", "locationAllTime", "smsAddOnsBuyed", "smsAddOnsRemaining", "totalLocationsPlan", "totalSmsVisitsPlan", "totalUrlVisitsPlan"]} |
f402b8a4-69ce-4a42-91d7-e5fd7cf5eacf/d88fa170-fef0-4c74-8665-0e289cb405de/0/0 | MyIPJSON | Get Your IP Address as JSON Response | null | getIP | Get your IP Address in JSON Format | 200 | New Example | {"origin": "13.228.169.5"} | {"type": "object", "properties": {"origin": {"type": "string"}}} |
6784fd39-760e-4ba7-95ef-034d2b2a0c3c/82f4eb1f-dde0-4102-a235-0021a719b59c/0/0 | Natural Language Actions API: Zappier Playground | Natural Language Actions API: Zappier Playground for Through Testing | null | execute_app_action_endpoint | Give us a plain english description of exact action you want to do. There should be dynamically generated documentation for this endpoint for each action that is exposed. | 200 | null | {"action_used": "", "additional_results": [], "assistant_hint": "", "error": "", "id": "", "input_params": {}, "result": {}, "result_field_labels": {}, "review_url": "", "status": "success"} | {"description": "This is a summary of the results given the action that was executed.", "properties": {"action_used": {"description": "The name of the action that was executed.", "title": "Action Used", "type": "string"}, "additional_results": {"description": "The rest of the full results. Always returns an array of objects", "items": {"type": "object"}, "title": "Additional Results", "type": "array"}, "assistant_hint": {"description": "A hint for the assistant on what to do next.", "title": "Assistant Hint", "type": "string"}, "error": {"description": "The error message if the execution failed.", "title": "Error", "type": "string"}, "id": {"description": "The id of the execution log.", "title": "Id", "type": "string"}, "input_params": {"description": "The params we used / will use to execute the action.", "title": "Input Params", "type": "object"}, "result": {"description": "A trimmed down result of the first item of the full results. Ideal for humans and language models!", "title": "Result", "type": "object"}, "result_field_labels": {"description": "Human readable labels for some of the keys in the result.", "title": "Result Field Labels", "type": "object"}, "review_url": {"description": "The URL to run the action or review the AI choices the AI made for input_params given instructions.", "title": "Review Url", "type": "string"}, "status": {"default": "success", "description": "The status of the execution.", "enum": ["success", "error", "empty", "preview"], "title": "Status", "type": "string"}}, "required": ["id", "action_used", "input_params", "review_url", "additional_results"], "title": "ExecuteResponse", "type": "object"} |
6784fd39-760e-4ba7-95ef-034d2b2a0c3c/82f4eb1f-dde0-4102-a235-0021a719b59c/1/0 | Natural Language Actions API: Zappier Playground | Natural Language Actions API: Zappier Playground for Through Testing | null | execute_app_action_endpoint | Give us a plain english description of exact action you want to do. There should be dynamically generated documentation for this endpoint for each action that is exposed. | 400 | null | {"error": ""} | {"properties": {"error": {"description": "Error message.", "title": "Error", "type": "string"}}, "required": ["error"], "title": "ErrorResponse", "type": "object"} |
6784fd39-760e-4ba7-95ef-034d2b2a0c3c/77d0782c-883a-4832-a91d-e56aefd2e638/0/0 | Natural Language Actions API: Zappier Playground | Natural Language Actions API: Zappier Playground for Through Testing | null | get_execution_log_endpoint | Get the execution log for a given execution log id. | 400 | null | {"error": ""} | {"properties": {"error": {"description": "Error message.", "title": "Error", "type": "string"}}, "required": ["error"], "title": "ErrorResponse", "type": "object"} |
6784fd39-760e-4ba7-95ef-034d2b2a0c3c/77d0782c-883a-4832-a91d-e56aefd2e638/1/0 | Natural Language Actions API: Zappier Playground | Natural Language Actions API: Zappier Playground for Through Testing | null | get_execution_log_endpoint | Get the execution log for a given execution log id. | 200 | null | {"action_used": "", "additional_results": [], "assistant_hint": "", "error": "", "id": "", "input_params": {}, "result": {}, "result_field_labels": {}, "review_url": "", "status": "success"} | {"description": "This is a summary of the results given the action that was executed.", "properties": {"action_used": {"description": "The name of the action that was executed.", "title": "Action Used", "type": "string"}, "additional_results": {"description": "The rest of the full results. Always returns an array of objects", "items": {"type": "object"}, "title": "Additional Results", "type": "array"}, "assistant_hint": {"description": "A hint for the assistant on what to do next.", "title": "Assistant Hint", "type": "string"}, "error": {"description": "The error message if the execution failed.", "title": "Error", "type": "string"}, "id": {"description": "The id of the execution log.", "title": "Id", "type": "string"}, "input_params": {"description": "The params we used / will use to execute the action.", "title": "Input Params", "type": "object"}, "result": {"description": "A trimmed down result of the first item of the full results. Ideal for humans and language models!", "title": "Result", "type": "object"}, "result_field_labels": {"description": "Human readable labels for some of the keys in the result.", "title": "Result Field Labels", "type": "object"}, "review_url": {"description": "The URL to run the action or review the AI choices the AI made for input_params given instructions.", "title": "Review Url", "type": "string"}, "status": {"default": "success", "description": "The status of the execution.", "enum": ["success", "error", "empty", "preview"], "title": "Status", "type": "string"}}, "required": ["id", "action_used", "input_params", "review_url", "additional_results"], "title": "ExecuteResponse", "type": "object"} |
6784fd39-760e-4ba7-95ef-034d2b2a0c3c/91ef0d62-f73d-4066-b2f2-f5c38cedee2a/0/0 | Natural Language Actions API: Zappier Playground | Natural Language Actions API: Zappier Playground for Through Testing | null | list_exposed_actions | List all the currently exposed actions for the given account. | 200 | null | {"configuration_link": "", "results": [{"description": "", "id": "", "operation_id": "", "params": {}}]} | {"properties": {"configuration_link": {"description": "URL to configure and expose more actions.", "title": "Configuration Link", "type": "string"}, "results": {"items": {"properties": {"description": {"description": "Description of the action.", "title": "Description", "type": "string"}, "id": {"description": "The unique ID of the exposed action.", "title": "Id", "type": "string"}, "operation_id": {"description": "The operation ID of the exposed action.", "title": "Operation Id", "type": "string"}, "params": {"description": "Available hint fields for the action.", "title": "Params", "type": "object"}}, "required": ["id", "operation_id", "description", "params"], "title": "ExposedActionSchema", "type": "object"}, "title": "Results", "type": "array"}}, "required": ["results", "configuration_link"], "title": "ExposedActionResponseSchema", "type": "object"} |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.