FairePlace Property Management API

Syndic Management

Endpointhttps://api.faireplace.com/api

List all syndics

GET

https://api.faireplace.com/api

/syndics

Returns all syndics for the current tenant.

List all syndics › Responses

List of syndics

object[]

Syndic (copropriété management company) response

id

string · uuid · required

estate_id

string · uuid · required

ID of the estate managed by this syndic

name

string · required

Syndic company name

contract_start

string · date · required

Start date of the syndic management contract

is_active

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

siren

string | null

SIREN number (9 digits)

address

string | null

contact_email

string | null

contact_phone

string | null

contract_end

string | null · date

End date of the syndic management contract

management_fee

number | null · decimal

Annual management fee

notes

string | null

GET/syndics

curl --request GET \
  --url https://api.faireplace.com/api/syndics

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "estate_id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "siren": {},
    "address": {},
    "contact_email": {},
    "contact_phone": {},
    "contract_start": "2024-08-25",
    "contract_end": "2024-08-25",
    "management_fee": {},
    "is_active": true,
    "notes": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Get a syndic by ID

GET

https://api.faireplace.com/api

/syndics/{syndic_id}

Get a syndic by ID › path Parameters

syndic_id

string · uuid · required

Get a syndic by ID › Responses

Syndic details

Syndic (copropriété management company) response

id

string · uuid · required

estate_id

string · uuid · required

ID of the estate managed by this syndic

name

string · required

Syndic company name

contract_start

string · date · required

Start date of the syndic management contract

is_active

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

siren

string | null

SIREN number (9 digits)

address

string | null

contact_email

string | null

contact_phone

string | null

contract_end

string | null · date

End date of the syndic management contract

management_fee

number | null · decimal

Annual management fee

notes

string | null

GET/syndics/{syndic_id}

curl --request GET \
  --url https://api.faireplace.com/api/syndics/:syndic_id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "siren": {},
  "address": {},
  "contact_email": {},
  "contact_phone": {},
  "contract_start": "2024-08-25",
  "contract_end": "2024-08-25",
  "management_fee": {},
  "is_active": true,
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update a syndic

PUT

https://api.faireplace.com/api

/syndics/{syndic_id}

Update a syndic › path Parameters

syndic_id

string · uuid · required

Update a syndic › Request Body

Data for updating a syndic (all fields optional)

name

string | null

siren

string | null

address

string | null

contact_email

string | null

contact_phone

string | null

contract_start

string | null · date

contract_end

string | null · date

management_fee

number | null · decimal

is_active

boolean | null

notes

string | null

Update a syndic › Responses

Syndic updated

Syndic (copropriété management company) response

id

string · uuid · required

estate_id

string · uuid · required

ID of the estate managed by this syndic

name

string · required

Syndic company name

contract_start

string · date · required

Start date of the syndic management contract

is_active

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

siren

string | null

SIREN number (9 digits)

address

string | null

contact_email

string | null

contact_phone

string | null

contract_end

string | null · date

End date of the syndic management contract

management_fee

number | null · decimal

Annual management fee

notes

string | null

PUT/syndics/{syndic_id}

curl --request PUT \
  --url https://api.faireplace.com/api/syndics/:syndic_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": {},
  "siren": {},
  "address": {},
  "contact_email": {},
  "contact_phone": {},
  "contract_start": "2024-08-25",
  "contract_end": "2024-08-25",
  "management_fee": {},
  "is_active": {},
  "notes": {}
}
'

shell

Example Request Body

{
  "name": {},
  "siren": {},
  "address": {},
  "contact_email": {},
  "contact_phone": {},
  "contract_start": "2024-08-25",
  "contract_end": "2024-08-25",
  "management_fee": {},
  "is_active": {},
  "notes": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "siren": {},
  "address": {},
  "contact_email": {},
  "contact_phone": {},
  "contract_start": "2024-08-25",
  "contract_end": "2024-08-25",
  "management_fee": {},
  "is_active": true,
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete a syndic

DELETE

https://api.faireplace.com/api

/syndics/{syndic_id}

Delete a syndic › path Parameters

syndic_id

string · uuid · required

Delete a syndic › Responses

Syndic deleted

No data returned

DELETE/syndics/{syndic_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/syndics/:syndic_id

shell

Example Responses

No example specified for this content type

Get syndic for an estate

GET

https://api.faireplace.com/api

/estates/{estate_id}/syndic

Returns the syndic linked to a specific estate (1:1 relationship).

Get syndic for an estate › path Parameters

estate_id

string · uuid · required

Get syndic for an estate › Responses

Syndic for this estate

Syndic (copropriété management company) response

id

string · uuid · required

estate_id

string · uuid · required

ID of the estate managed by this syndic

name

string · required

Syndic company name

contract_start

string · date · required

Start date of the syndic management contract

is_active

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

siren

string | null

SIREN number (9 digits)

address

string | null

contact_email

string | null

contact_phone

string | null

contract_end

string | null · date

End date of the syndic management contract

management_fee

number | null · decimal

Annual management fee

notes

string | null

GET/estates/{estate_id}/syndic

curl --request GET \
  --url https://api.faireplace.com/api/estates/:estate_id/syndic

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "siren": {},
  "address": {},
  "contact_email": {},
  "contact_phone": {},
  "contract_start": "2024-08-25",
  "contract_end": "2024-08-25",
  "management_fee": {},
  "is_active": true,
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Create a syndic for an estate

POST

https://api.faireplace.com/api

/estates/{estate_id}/syndic

Creates a new syndic management company linked to an estate.

Create a syndic for an estate › path Parameters

estate_id

string · uuid · required

Create a syndic for an estate › Request Body

Data for creating a syndic

name

string · required

Syndic company name

contract_start

string · date · required

siren

string | null

SIREN number (9 digits)

address

string | null

contact_email

string | null

contact_phone

string | null

contract_end

string | null · date

management_fee

number | null · decimal

notes

string | null

Create a syndic for an estate › Responses

Syndic created

Syndic (copropriété management company) response

id

string · uuid · required

estate_id

string · uuid · required

ID of the estate managed by this syndic

name

string · required

Syndic company name

contract_start

string · date · required

Start date of the syndic management contract

is_active

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

siren

string | null

SIREN number (9 digits)

address

string | null

contact_email

string | null

contact_phone

string | null

contract_end

string | null · date

End date of the syndic management contract

management_fee

number | null · decimal

Annual management fee

notes

string | null

POST/estates/{estate_id}/syndic

curl --request POST \
  --url https://api.faireplace.com/api/estates/:estate_id/syndic \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "siren": {},
  "address": {},
  "contact_email": {},
  "contact_phone": {},
  "contract_start": "2024-08-25",
  "contract_end": "2024-08-25",
  "management_fee": {},
  "notes": {}
}
'

shell

Example Request Body

{
  "name": "name",
  "siren": {},
  "address": {},
  "contact_email": {},
  "contact_phone": {},
  "contract_start": "2024-08-25",
  "contract_end": "2024-08-25",
  "management_fee": {},
  "notes": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "estate_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "siren": {},
  "address": {},
  "contact_email": {},
  "contact_phone": {},
  "contract_start": "2024-08-25",
  "contract_end": "2024-08-25",
  "management_fee": {},
  "is_active": true,
  "notes": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Webhooks Syndic Fund Calls