FairePlace Property Management API

Contacts

Endpointhttps://api.faireplace.com/api

Contact management

List contacts

GET

https://api.faireplace.com/api

/contacts

List contacts › Responses

object[]

id

string · uuid

first_name

string | null

last_name

string | null · maxLength: 255

email

string | null · email

phone

string | null

address

object | null

created_at

string · date-time

updated_at

string · date-time

GET/contacts

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

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "first_name": {},
    "last_name": {},
    "email": "[email protected]",
    "phone": {},
    "address": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Create contact

POST

https://api.faireplace.com/api

/contacts

Create contact › Request Body

type_contact

string · required

email

string · email · required

mobile

string · required

category

string · required

address_line1

string · required

address_city

string · required

address_postal_code

string · required

address_country

string · required

first_name

string | null

last_name

string | null

legal_name

string | null

registration_number

string | null

telephone

string | null

website

string | null · uri

color

string | null

address_line2

string | null

address_region

string | null

bank_name

string | null

bank_address

string | null

bank_city

string | null

bank_postal_code

string | null

bank_country

string | null

iban

string | null

swift_bic

string | null

bank_account_holder

string | null

professional_activity

string | null

professional_card_number

string | null

professional_card_issuing_location

string | null

professional_card_issuing_date

string | null · date

professional_card_expiry_date

string | null · date

professional_registration_number

string | null

professional_guarantor_id

string | null · uuid

professional_insurance_company

string | null

professional_insurance_policy

string | null

professional_status

string | null

Create contact › Responses

Created

id

string · uuid

first_name

string | null

last_name

string | null · maxLength: 255

email

string | null · email

phone

string | null

address

object | null

created_at

string · date-time

updated_at

string · date-time

POST/contacts

curl --request POST \
  --url https://api.faireplace.com/api/contacts \
  --header 'Content-Type: application/json' \
  --data '
{
  "type_contact": "type_contact",
  "first_name": {},
  "last_name": {},
  "legal_name": {},
  "registration_number": {},
  "email": "[email protected]",
  "mobile": "mobile",
  "telephone": {},
  "website": "https://www.example.com/path/to/resource",
  "color": {},
  "category": "category",
  "address_line1": "address_line1",
  "address_line2": {},
  "address_city": "address_city",
  "address_postal_code": "address_postal_code",
  "address_region": {},
  "address_country": "address_country",
  "bank_name": {},
  "bank_address": {},
  "bank_city": {},
  "bank_postal_code": {},
  "bank_country": {},
  "iban": {},
  "swift_bic": {},
  "bank_account_holder": {},
  "professional_activity": {},
  "professional_card_number": {},
  "professional_card_issuing_location": {},
  "professional_card_issuing_date": "2024-08-25",
  "professional_card_expiry_date": "2024-08-25",
  "professional_registration_number": {},
  "professional_guarantor_id": "00000000-0000-0000-0000-000000000000",
  "professional_insurance_company": {},
  "professional_insurance_policy": {},
  "professional_status": {}
}
'

shell

Example Request Body

{
  "type_contact": "type_contact",
  "first_name": {},
  "last_name": {},
  "legal_name": {},
  "registration_number": {},
  "email": "[email protected]",
  "mobile": "mobile",
  "telephone": {},
  "website": "https://www.example.com/path/to/resource",
  "color": {},
  "category": "category",
  "address_line1": "address_line1",
  "address_line2": {},
  "address_city": "address_city",
  "address_postal_code": "address_postal_code",
  "address_region": {},
  "address_country": "address_country",
  "bank_name": {},
  "bank_address": {},
  "bank_city": {},
  "bank_postal_code": {},
  "bank_country": {},
  "iban": {},
  "swift_bic": {},
  "bank_account_holder": {},
  "professional_activity": {},
  "professional_card_number": {},
  "professional_card_issuing_location": {},
  "professional_card_issuing_date": "2024-08-25",
  "professional_card_expiry_date": "2024-08-25",
  "professional_registration_number": {},
  "professional_guarantor_id": "00000000-0000-0000-0000-000000000000",
  "professional_insurance_company": {},
  "professional_insurance_policy": {},
  "professional_status": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "first_name": {},
  "last_name": {},
  "email": "[email protected]",
  "phone": {},
  "address": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get contact

GET

https://api.faireplace.com/api

/contacts/{id}

Get contact › path Parameters

id

string · uuid · required

Get contact › Responses

id

string · uuid

first_name

string | null

last_name

string | null · maxLength: 255

email

string | null · email

phone

string | null

address

object | null

created_at

string · date-time

updated_at

string · date-time

GET/contacts/{id}

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

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "first_name": {},
  "last_name": {},
  "email": "[email protected]",
  "phone": {},
  "address": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update contact

PUT

https://api.faireplace.com/api

/contacts/{id}

Update contact › path Parameters

id

string · uuid · required

Update contact › Request Body

type_contact

string

first_name

string | null

last_name

string | null

legal_name

string | null

registration_number

string | null

email

string · email

mobile

string

telephone

string | null

website

string | null · uri

color

string | null

category

string

address_line1

string

address_line2

string | null

address_city

string

address_postal_code

string

address_region

string | null

address_country

string

bank_name

string | null

bank_address

string | null

bank_city

string | null

bank_postal_code

string | null

bank_country

string | null

iban

string | null

swift_bic

string | null

bank_account_holder

string | null

professional_activity

string | null

professional_card_number

string | null

professional_card_issuing_location

string | null

professional_card_issuing_date

string | null · date

professional_card_expiry_date

string | null · date

professional_registration_number

string | null

professional_guarantor_id

string | null · uuid

professional_insurance_company

string | null

professional_insurance_policy

string | null

professional_status

string | null

Update contact › Responses

id

string · uuid

first_name

string | null

last_name

string | null · maxLength: 255

email

string | null · email

phone

string | null

address

object | null

created_at

string · date-time

updated_at

string · date-time

PUT/contacts/{id}

curl --request PUT \
  --url https://api.faireplace.com/api/contacts/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "type_contact": "type_contact",
  "first_name": {},
  "last_name": {},
  "legal_name": {},
  "registration_number": {},
  "email": "[email protected]",
  "mobile": "mobile",
  "telephone": {},
  "website": "https://www.example.com/path/to/resource",
  "color": {},
  "category": "category",
  "address_line1": "address_line1",
  "address_line2": {},
  "address_city": "address_city",
  "address_postal_code": "address_postal_code",
  "address_region": {},
  "address_country": "address_country",
  "bank_name": {},
  "bank_address": {},
  "bank_city": {},
  "bank_postal_code": {},
  "bank_country": {},
  "iban": {},
  "swift_bic": {},
  "bank_account_holder": {},
  "professional_activity": {},
  "professional_card_number": {},
  "professional_card_issuing_location": {},
  "professional_card_issuing_date": "2024-08-25",
  "professional_card_expiry_date": "2024-08-25",
  "professional_registration_number": {},
  "professional_guarantor_id": "00000000-0000-0000-0000-000000000000",
  "professional_insurance_company": {},
  "professional_insurance_policy": {},
  "professional_status": {}
}
'

shell

Example Request Body

{
  "type_contact": "type_contact",
  "first_name": {},
  "last_name": {},
  "legal_name": {},
  "registration_number": {},
  "email": "[email protected]",
  "mobile": "mobile",
  "telephone": {},
  "website": "https://www.example.com/path/to/resource",
  "color": {},
  "category": "category",
  "address_line1": "address_line1",
  "address_line2": {},
  "address_city": "address_city",
  "address_postal_code": "address_postal_code",
  "address_region": {},
  "address_country": "address_country",
  "bank_name": {},
  "bank_address": {},
  "bank_city": {},
  "bank_postal_code": {},
  "bank_country": {},
  "iban": {},
  "swift_bic": {},
  "bank_account_holder": {},
  "professional_activity": {},
  "professional_card_number": {},
  "professional_card_issuing_location": {},
  "professional_card_issuing_date": "2024-08-25",
  "professional_card_expiry_date": "2024-08-25",
  "professional_registration_number": {},
  "professional_guarantor_id": "00000000-0000-0000-0000-000000000000",
  "professional_insurance_company": {},
  "professional_insurance_policy": {},
  "professional_status": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "first_name": {},
  "last_name": {},
  "email": "[email protected]",
  "phone": {},
  "address": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete contact

DELETE

https://api.faireplace.com/api

/contacts/{id}

Delete contact › path Parameters

id

string · uuid · required

Delete contact › Responses

No Content

No data returned

DELETE/contacts/{id}

curl --request DELETE \
  --url https://api.faireplace.com/api/contacts/:id

shell

Example Responses

No example specified for this content type

Health Estates

FairePlace Property Management API

Contacts

Endpointhttps://api.faireplace.com/api

Contact management

List contacts

GET

https://api.faireplace.com/api

/contacts

List contacts › Responses

object[]

id

string · uuid

first_name

string | null

last_name

string | null · maxLength: 255

email

string | null · email

phone

string | null

address

object | null

created_at

string · date-time

updated_at

string · date-time

GET/contacts

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

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "first_name": {},
    "last_name": {},
    "email": "[email protected]",
    "phone": {},
    "address": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Create contact

POST

https://api.faireplace.com/api

/contacts

Create contact › Request Body

type_contact

string · required

email

string · email · required

mobile

string · required

category

string · required

address_line1

string · required

address_city

string · required

address_postal_code

string · required

address_country

string · required

first_name

string | null

last_name

string | null

legal_name

string | null

registration_number

string | null

telephone

string | null

website

string | null · uri

color

string | null

address_line2

string | null

address_region

string | null

bank_name

string | null

bank_address

string | null

bank_city

string | null

bank_postal_code

string | null

bank_country

string | null

iban

string | null

swift_bic

string | null

bank_account_holder

string | null

professional_activity

string | null

professional_card_number

string | null

professional_card_issuing_location

string | null

professional_card_issuing_date

string | null · date

professional_card_expiry_date

string | null · date

professional_registration_number

string | null

professional_guarantor_id

string | null · uuid

professional_insurance_company

string | null

professional_insurance_policy

string | null

professional_status

string | null

Create contact › Responses

Created

id

string · uuid

first_name

string | null

last_name

string | null · maxLength: 255

email

string | null · email

phone

string | null

address

object | null

created_at

string · date-time

updated_at

string · date-time

POST/contacts

curl --request POST \
  --url https://api.faireplace.com/api/contacts \
  --header 'Content-Type: application/json' \
  --data '
{
  "type_contact": "type_contact",
  "first_name": {},
  "last_name": {},
  "legal_name": {},
  "registration_number": {},
  "email": "[email protected]",
  "mobile": "mobile",
  "telephone": {},
  "website": "https://www.example.com/path/to/resource",
  "color": {},
  "category": "category",
  "address_line1": "address_line1",
  "address_line2": {},
  "address_city": "address_city",
  "address_postal_code": "address_postal_code",
  "address_region": {},
  "address_country": "address_country",
  "bank_name": {},
  "bank_address": {},
  "bank_city": {},
  "bank_postal_code": {},
  "bank_country": {},
  "iban": {},
  "swift_bic": {},
  "bank_account_holder": {},
  "professional_activity": {},
  "professional_card_number": {},
  "professional_card_issuing_location": {},
  "professional_card_issuing_date": "2024-08-25",
  "professional_card_expiry_date": "2024-08-25",
  "professional_registration_number": {},
  "professional_guarantor_id": "00000000-0000-0000-0000-000000000000",
  "professional_insurance_company": {},
  "professional_insurance_policy": {},
  "professional_status": {}
}
'

shell

Example Request Body

{
  "type_contact": "type_contact",
  "first_name": {},
  "last_name": {},
  "legal_name": {},
  "registration_number": {},
  "email": "[email protected]",
  "mobile": "mobile",
  "telephone": {},
  "website": "https://www.example.com/path/to/resource",
  "color": {},
  "category": "category",
  "address_line1": "address_line1",
  "address_line2": {},
  "address_city": "address_city",
  "address_postal_code": "address_postal_code",
  "address_region": {},
  "address_country": "address_country",
  "bank_name": {},
  "bank_address": {},
  "bank_city": {},
  "bank_postal_code": {},
  "bank_country": {},
  "iban": {},
  "swift_bic": {},
  "bank_account_holder": {},
  "professional_activity": {},
  "professional_card_number": {},
  "professional_card_issuing_location": {},
  "professional_card_issuing_date": "2024-08-25",
  "professional_card_expiry_date": "2024-08-25",
  "professional_registration_number": {},
  "professional_guarantor_id": "00000000-0000-0000-0000-000000000000",
  "professional_insurance_company": {},
  "professional_insurance_policy": {},
  "professional_status": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "first_name": {},
  "last_name": {},
  "email": "[email protected]",
  "phone": {},
  "address": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get contact

GET

https://api.faireplace.com/api

/contacts/{id}

Get contact › path Parameters

id

string · uuid · required

Get contact › Responses

id

string · uuid

first_name

string | null

last_name

string | null · maxLength: 255

email

string | null · email

phone

string | null

address

object | null

created_at

string · date-time

updated_at

string · date-time

GET/contacts/{id}

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

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "first_name": {},
  "last_name": {},
  "email": "[email protected]",
  "phone": {},
  "address": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update contact

PUT

https://api.faireplace.com/api

/contacts/{id}

Update contact › path Parameters

id

string · uuid · required

Update contact › Request Body

type_contact

string

first_name

string | null

last_name

string | null

legal_name

string | null

registration_number

string | null

email

string · email

mobile

string

telephone

string | null

website

string | null · uri

color

string | null

category

string

address_line1

string

address_line2

string | null

address_city

string

address_postal_code

string

address_region

string | null

address_country

string

bank_name

string | null

bank_address

string | null

bank_city

string | null

bank_postal_code

string | null

bank_country

string | null

iban

string | null

swift_bic

string | null

bank_account_holder

string | null

professional_activity

string | null

professional_card_number

string | null

professional_card_issuing_location

string | null

professional_card_issuing_date

string | null · date

professional_card_expiry_date

string | null · date

professional_registration_number

string | null

professional_guarantor_id

string | null · uuid

professional_insurance_company

string | null

professional_insurance_policy

string | null

professional_status

string | null

Update contact › Responses

id

string · uuid

first_name

string | null

last_name

string | null · maxLength: 255

email

string | null · email

phone

string | null

address

object | null

created_at

string · date-time

updated_at

string · date-time

PUT/contacts/{id}

curl --request PUT \
  --url https://api.faireplace.com/api/contacts/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "type_contact": "type_contact",
  "first_name": {},
  "last_name": {},
  "legal_name": {},
  "registration_number": {},
  "email": "[email protected]",
  "mobile": "mobile",
  "telephone": {},
  "website": "https://www.example.com/path/to/resource",
  "color": {},
  "category": "category",
  "address_line1": "address_line1",
  "address_line2": {},
  "address_city": "address_city",
  "address_postal_code": "address_postal_code",
  "address_region": {},
  "address_country": "address_country",
  "bank_name": {},
  "bank_address": {},
  "bank_city": {},
  "bank_postal_code": {},
  "bank_country": {},
  "iban": {},
  "swift_bic": {},
  "bank_account_holder": {},
  "professional_activity": {},
  "professional_card_number": {},
  "professional_card_issuing_location": {},
  "professional_card_issuing_date": "2024-08-25",
  "professional_card_expiry_date": "2024-08-25",
  "professional_registration_number": {},
  "professional_guarantor_id": "00000000-0000-0000-0000-000000000000",
  "professional_insurance_company": {},
  "professional_insurance_policy": {},
  "professional_status": {}
}
'

shell

Example Request Body

{
  "type_contact": "type_contact",
  "first_name": {},
  "last_name": {},
  "legal_name": {},
  "registration_number": {},
  "email": "[email protected]",
  "mobile": "mobile",
  "telephone": {},
  "website": "https://www.example.com/path/to/resource",
  "color": {},
  "category": "category",
  "address_line1": "address_line1",
  "address_line2": {},
  "address_city": "address_city",
  "address_postal_code": "address_postal_code",
  "address_region": {},
  "address_country": "address_country",
  "bank_name": {},
  "bank_address": {},
  "bank_city": {},
  "bank_postal_code": {},
  "bank_country": {},
  "iban": {},
  "swift_bic": {},
  "bank_account_holder": {},
  "professional_activity": {},
  "professional_card_number": {},
  "professional_card_issuing_location": {},
  "professional_card_issuing_date": "2024-08-25",
  "professional_card_expiry_date": "2024-08-25",
  "professional_registration_number": {},
  "professional_guarantor_id": "00000000-0000-0000-0000-000000000000",
  "professional_insurance_company": {},
  "professional_insurance_policy": {},
  "professional_status": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "first_name": {},
  "last_name": {},
  "email": "[email protected]",
  "phone": {},
  "address": {},
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete contact

DELETE

https://api.faireplace.com/api

/contacts/{id}

Delete contact › path Parameters

id

string · uuid · required

Delete contact › Responses

No Content

No data returned

DELETE/contacts/{id}

curl --request DELETE \
  --url https://api.faireplace.com/api/contacts/:id

shell

Example Responses

No example specified for this content type

Health Estates