With an API (Application Programming Interface), you can easily connect programs or develop your own extensions. At the bottom of this page, you will find all available commands.
Our API is available for paying users. You can enable the API in your account preferences. After logging in, you will also find your private API key and can test the commands before using them in your own app.
General information
Error messages, such as an access denial, are displayed as follows:
{
"success": false,
"message": "Returned message"
}
"success": false,
"message": "Returned message"
}
The examples shown here can be automated within your own programming environment. You can find corresponding examples on SourceForge.
Example: General data
Get all buildings AND units owned by me
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get my buildings and units"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get my buildings and units"
}
Get all buildings you are connected to:
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get all buildings"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get all buildings"
}
Add building
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "add building",
"build_name": "{a name}",
"build_type": "{House, Apartments, Student dormitory, Community Building, Education, welfare, Movable unit, Mixed use, Detached, Parking, Parcels, Other}",
"build_main_use": "{own_use, tenancy, rented, for_sale, sold, concessiongiven, concessiontaken}",
"builduser_building_owner": "{1 or 0}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "add building",
"build_name": "{a name}",
"build_type": "{House, Apartments, Student dormitory, Community Building, Education, welfare, Movable unit, Mixed use, Detached, Parking, Parcels, Other}",
"build_main_use": "{own_use, tenancy, rented, for_sale, sold, concessiongiven, concessiontaken}",
"builduser_building_owner": "{1 or 0}"
}
Change building
(this one is an exception: only here, you can delete non-required fields. They will be ignored)
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "change building",
"build_ref": "{build_ref}",
"build_name": "{name}",
"build_contains_managed_parts": "{0 or 1}",
"build_type": "{House, Apartments, Student dormitory, Community Building, Education, welfare, Movable unit, Mixed use, Detached, Parking, Parcels, Other}",
"build_main_use": "{own_use, tenancy, rented, for_sale, sold, concessiongiven, concessiontaken}",
"build_country": "{country code, e.g. BE, DE, US,…}",
"build_state": "{e.g. BE_VL for Flanders, Belgium; DE_BB for Brandenburg, Germany,… }",
"build_city_town": "{town or city name}",
"build_postal_code": "{postal code}",
"build_province": "{province}",
"build_street_name": "{street name}",
"build_number": "{number}",
"build_number_additional": "{letter}",
"build_bus": "{number}",
"build_currency": "EUR, GBP, NOK, USD,…",
"build_communication_language": "{de, en, es, fr, nl, pt}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "change building",
"build_ref": "{build_ref}",
"build_name": "{name}",
"build_contains_managed_parts": "{0 or 1}",
"build_type": "{House, Apartments, Student dormitory, Community Building, Education, welfare, Movable unit, Mixed use, Detached, Parking, Parcels, Other}",
"build_main_use": "{own_use, tenancy, rented, for_sale, sold, concessiongiven, concessiontaken}",
"build_country": "{country code, e.g. BE, DE, US,…}",
"build_state": "{e.g. BE_VL for Flanders, Belgium; DE_BB for Brandenburg, Germany,… }",
"build_city_town": "{town or city name}",
"build_postal_code": "{postal code}",
"build_province": "{province}",
"build_street_name": "{street name}",
"build_number": "{number}",
"build_number_additional": "{letter}",
"build_bus": "{number}",
"build_currency": "EUR, GBP, NOK, USD,…",
"build_communication_language": "{de, en, es, fr, nl, pt}"
}
Delete building
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "delete building",
"build_ref": "{build_ref}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "delete building",
"build_ref": "{build_ref}"
}
Get all units in a building (if you have access)
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get all units",
"build_ref": "{build_ref}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get all units",
"build_ref": "{build_ref}"
}
Add unit
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "add unit",
"build_ref": "{build_ref}",
"build_street_name": "{street name, optional}",
"build_number": "{number, optional}",
"build_number_additional": "{addition, optional}",
"build_bus": "{bus, optional}",
"number_of_units_to_create": "{number, required}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "add unit",
"build_ref": "{build_ref}",
"build_street_name": "{street name, optional}",
"build_number": "{number, optional}",
"build_number_additional": "{addition, optional}",
"build_bus": "{bus, optional}",
"number_of_units_to_create": "{number, required}"
}
Change unit (this one is an exception: only here, you can delete non-required fields. They will be ignored)
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "change unit",
"build_ref": "{build_ref}",
"unit_ref": "{unit_ref}",
"unit_name": "{name, optional}",
"unit_description": "{description, optional}",
"unit_type": "{House, Apartments, Studio, Office, Store, Community, Student room, Seasonal worker's room, Storage room, Mixed use, Parking lot, Bike space, Garden, Common areas, Parcel, Other, undefined}",
"unit_street_name": "{street name, optional}",
"unit_number": "{number}",
"unit_number_additional": "{letter}",
"unit_bus": "{number}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "change unit",
"build_ref": "{build_ref}",
"unit_ref": "{unit_ref}",
"unit_name": "{name, optional}",
"unit_description": "{description, optional}",
"unit_type": "{House, Apartments, Studio, Office, Store, Community, Student room, Seasonal worker's room, Storage room, Mixed use, Parking lot, Bike space, Garden, Common areas, Parcel, Other, undefined}",
"unit_street_name": "{street name, optional}",
"unit_number": "{number}",
"unit_number_additional": "{letter}",
"unit_bus": "{number}"
}
Delete unit
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "delete unit",
"build_ref": "{build_ref}",
"unit_ref": "{unit_ref}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "delete unit",
"build_ref": "{build_ref}",
"unit_ref": "{unit_ref}"
}
Get your land items:
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get all land items"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get all land items"
}
Add/change land item
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "add/change land item",
"build_ref": "{build_ref, if changing an existing item}",
"build_geolocation": "{geolocation, e.g. 51.25145015222234,3.2815217971801762; at least one of the geolocation, description of registration is required}",
"build_location_description": "{address; at least one of the geolocation, description of registration is required}",
"build_location_registration": "{parcel number; at least one of the geolocation, description of registration is required}",
"build_name": "{name, required}",
"build_type": "{reported, event, green, roadworks, undeveloped, vacancy, dilapidation, safety, enforcement, unknown}",
"build_land_active": "{empty, active or nonactive}",
"build_land_description": "{a description}",
"build_reporter_name": "{a name, not required}",
"build_reporter_email": "{a valid email address, not required}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "add/change land item",
"build_ref": "{build_ref, if changing an existing item}",
"build_geolocation": "{geolocation, e.g. 51.25145015222234,3.2815217971801762; at least one of the geolocation, description of registration is required}",
"build_location_description": "{address; at least one of the geolocation, description of registration is required}",
"build_location_registration": "{parcel number; at least one of the geolocation, description of registration is required}",
"build_name": "{name, required}",
"build_type": "{reported, event, green, roadworks, undeveloped, vacancy, dilapidation, safety, enforcement, unknown}",
"build_land_active": "{empty, active or nonactive}",
"build_land_description": "{a description}",
"build_reporter_name": "{a name, not required}",
"build_reporter_email": "{a valid email address, not required}"
}
Delete land item
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "delete land item",
"build_ref": "{build_ref}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "delete land item",
"build_ref": "{build_ref}"
}
Get associates in a building
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get associates",
"build_ref": "{build_ref}"
"unit_ref": "{unit_ref}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get associates",
"build_ref": "{build_ref}"
"unit_ref": "{unit_ref}"
}
Example: projects
Get project data
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get projects",
"build_ref": "{build_ref}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get projects",
"build_ref": "{build_ref}"
}
Add/change project data
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "add/change project",
"build_ref": "{build_ref}",
"maintenance_ref": "{maintenance_ref, required if existing maintenance}",
"action_type": "{the word 'adjust' will process this item, anything else will make it an item to be reviewed}",
"maintenance_title": "{maintenance_title}",
"maintenance_description": "{maintenance_description}",
"maintenance_instructions": "{maintenance_instructions}",
"maintenance_reporting_date": "{YYYY-MM-DD}",
"maintenance_start_date": "{YYYY-MM-DD}",
"maintenance_end_date": "{YYYY-MM-DD}",
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "add/change project",
"build_ref": "{build_ref}",
"maintenance_ref": "{maintenance_ref, required if existing maintenance}",
"action_type": "{the word 'adjust' will process this item, anything else will make it an item to be reviewed}",
"maintenance_title": "{maintenance_title}",
"maintenance_description": "{maintenance_description}",
"maintenance_instructions": "{maintenance_instructions}",
"maintenance_reporting_date": "{YYYY-MM-DD}",
"maintenance_start_date": "{YYYY-MM-DD}",
"maintenance_end_date": "{YYYY-MM-DD}",
}
Delete project
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get projects",
"build_ref": "{build_ref}",
"maintenance_ref": "{maintenance_ref}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get projects",
"build_ref": "{build_ref}",
"maintenance_ref": "{maintenance_ref}"
}
Example: owners association and finances
Get owners associations from a building
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get owners associations",
"build_ref": "{build_ref}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get owners associations",
"build_ref": "{build_ref}"
}
Add/change owners association
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "add/change owners association",
"build_ref": "{build_ref}",
"oa_ref": "{oa_ref, if changing an existing owners association}",
"oa_name": "{oa_name, required}",
"oa_description": "{oa_description, optional}",
"oa_registration_number": "{oa_registration_number, optional}",
"oa_bank_account1": "{oa_bank_account1, optional IBAN number}",
"oa_bank_account2": "{oa_bank_account2, optional IBAN number}",
"oa_bank_account3": "{oa_bank_account3, optional IBAN number}",
"oa_bank_account4": "{oa_bank_account4, optional IBAN number}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "add/change owners association",
"build_ref": "{build_ref}",
"oa_ref": "{oa_ref, if changing an existing owners association}",
"oa_name": "{oa_name, required}",
"oa_description": "{oa_description, optional}",
"oa_registration_number": "{oa_registration_number, optional}",
"oa_bank_account1": "{oa_bank_account1, optional IBAN number}",
"oa_bank_account2": "{oa_bank_account2, optional IBAN number}",
"oa_bank_account3": "{oa_bank_account3, optional IBAN number}",
"oa_bank_account4": "{oa_bank_account4, optional IBAN number}"
}
Delete owners association and related finances
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "delete owners association",
"build_ref": "{build_ref}",
"oa_ref": "{oa_ref}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "delete owners association",
"build_ref": "{build_ref}",
"oa_ref": "{oa_ref}"
}
Get finances for a certain owners association
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get finances",
"build_ref": "{build_ref}",
"oa_ref": "{oa_ref}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get finances",
"build_ref": "{build_ref}",
"oa_ref": "{oa_ref}"
}
Add/change finance (change is only possible if not already marked as paid!)
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "add/change finance",
"build_ref": "{build_ref}",
"oa_ref": "{oa_ref, required}",
"buildfin_ref": "{buildfin_ref, if changing an existing transaction}",
"buildfin_bank_account": "just the number 1, 2, 3 or 4",
"buildfin_name": "{name, required}",
"buildfin_date": "{buildfin_date, required}",
"buildfin_category": "{maintenance, cleaning, constr_renov, energy, revenue, insurances, tax, advancepay, security_deposits, finalsettlements, mortgage, payroll, propman, own_contribution_and_reimbursement, acquisition_received_funds, acquisition_purchase_costs, other}",
"buildfin_paid": "{buildfin_paid: paid or unpaid, required}",
"buildfin_amount": "{buildfin_amount, required}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "add/change finance",
"build_ref": "{build_ref}",
"oa_ref": "{oa_ref, required}",
"buildfin_ref": "{buildfin_ref, if changing an existing transaction}",
"buildfin_bank_account": "just the number 1, 2, 3 or 4",
"buildfin_name": "{name, required}",
"buildfin_date": "{buildfin_date, required}",
"buildfin_category": "{maintenance, cleaning, constr_renov, energy, revenue, insurances, tax, advancepay, security_deposits, finalsettlements, mortgage, payroll, propman, own_contribution_and_reimbursement, acquisition_received_funds, acquisition_purchase_costs, other}",
"buildfin_paid": "{buildfin_paid: paid or unpaid, required}",
"buildfin_amount": "{buildfin_amount, required}"
}
Delete finance (only if not marked as paid!)
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "delete finance",
"build_ref": "{build_ref}",
"oa_ref": "{oa_ref}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "delete finance",
"build_ref": "{build_ref}",
"oa_ref": "{oa_ref}"
}
Get meetings
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get meetings",
"build_ref": "{build_ref}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get meetings",
"build_ref": "{build_ref}"
}
Get agenda items
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get agenda items",
"build_ref": "{build_ref}",
"oa_ref": "{oa_ref}",
"$meeting_ref": "{$meeting_ref}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get agenda items",
"build_ref": "{build_ref}",
"oa_ref": "{oa_ref}",
"$meeting_ref": "{$meeting_ref}"
}
Example: team management
Get team members
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get team members"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "get team members"
}
Add/change team member
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": " ",
"user_ref_public": "{user_ref_public of the target user, required if existing user}",
"user_name": "{user_name, required}",
"user_email": "{user_email, required}",
"user_password": "{user_password, PROVIDE ONLY IF IT NEEDS TO CHANGE}",
"user_tel1_country": "{contry code, such as +32 for Belgium}",
"user_tel1_number": "{number}",
"team_manager": "{on or empty, at least one function needs to be on}",
"team_task_organizer": "{on or empty, at least one function needs to be on}",
"team_task_worker": "{on or empty, at least one function needs to be on}",
"team_administrative_force": "{on or empty, at least one function needs to be on}",
"team_guest": "{on or empty, at least one function needs to be on}",
"team_disabled_user": "{on or empty}"
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": " ",
"user_ref_public": "{user_ref_public of the target user, required if existing user}",
"user_name": "{user_name, required}",
"user_email": "{user_email, required}",
"user_password": "{user_password, PROVIDE ONLY IF IT NEEDS TO CHANGE}",
"user_tel1_country": "{contry code, such as +32 for Belgium}",
"user_tel1_number": "{number}",
"team_manager": "{on or empty, at least one function needs to be on}",
"team_task_organizer": "{on or empty, at least one function needs to be on}",
"team_task_worker": "{on or empty, at least one function needs to be on}",
"team_administrative_force": "{on or empty, at least one function needs to be on}",
"team_guest": "{on or empty, at least one function needs to be on}",
"team_disabled_user": "{on or empty}"
}
Delete team members
{
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "delete team members",
"user_ref_public": "{user_ref_public of the target user, required}",
}
"userID": "{your user ID}",
"username": "{username}",
"password": "{password}",
"action": "delete team members",
"user_ref_public": "{user_ref_public of the target user, required}",
}
