FairePlace Property Management API

Keys

Endpointhttps://api.faireplace.com/api

Key management

List keys for a property

GET

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/keys

Retrieves the list of all keys associated with a property with filters and pagination

List keys for a property › path Parameters

place_id

string · uuid · required

place ID

estate_id

string · uuid · required

property ID

List keys for a property › query Parameters

key_type

string · enum

Filter by key type

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

status

string · enum

Filter by status

Key status

Enum values:

ACTIVE

RENDERED

LOST

STOLEN

DAMAGED

REPLACED

ARCHIVED

Example: ACTIVE

security_level

string · enum

Filter by security level

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

is_rendered

boolean

Filter by keys handed over/not handed over

brand

string

Filter by brand

page

integer · min: 1

Page number (default: 1)

Default: 1

limit

integer · min: 1 · max: 100

Number of items per page (default: 50, max: 100)

Default: 50

List keys for a property › Responses

Keys list retrieved successfully

Paginated response for key list

object[] · required

Key list

total

integer · required

Total number of keys

Example: 10

page

integer · required

Current page number

Example: 1

limit

integer · required

Number of items per page

Example: 50

GET/places/{place_id}/estates/{estate_id}/keys

curl --request GET \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/keys

shell

Example Responses

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "tenant_id": "sjIXqWvUyablBYwvIuAeADRCJvGS9bTX",
      "estate_id": "550e8400-e29b-41d4-a716-446655440001",
      "key_type": "CLEF",
      "description": "Main key for the apartment",
      "brand": "Serrurier Martin",
      "key_number": "KEY-001",
      "quantity": 2,
      "protected_code": "ABC123",
      "status": "ACTIVE",
      "security_level": "STANDARD",
      "access_restrictions": "Access restricted to residents and authorized personnel only",
      "emergency_contact": "+33 1 23 45 67 89",
      "is_rendered": false,
      "notes": "Enhanced security key",
      "rendered_to": "Jean Dupont",
      "rendered_by": "Marie Martin",
      "rendered_at": "2024-01-20T10:30:00Z",
      "expected_return_date": "2024-01-25T18:00:00Z",
      "purpose": "Apartment visit",
      "last_status_change_at": "2024-01-20T10:30:00Z",
      "last_status_change_by": "Marie Martin",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 10,
  "page": 1,
  "limit": 50
}

json

application/json

Create a new key

POST

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/keys

Creates a new key for a property

Create a new key › path Parameters

place_id

string · uuid · required

place ID

estate_id

string · uuid · required

property ID

Create a new key › Request Body

Data for creating a new key

key_type

string · enum · required

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

description

string · minLength: 1 · maxLength: 500 · required

Key description

Example: Main key for the apartment

security_level

string · enum · required

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

brand

string | null · maxLength: 100

Key or badge brand

Example: Serrurier Martin

key_number

string | null · maxLength: 100

Key or badge number

Example: KEY-001

quantity

integer · min: 1

Key quantity

Example: 2

protected_code

string | null · maxLength: 100

Key protection code

Example: ABC123

access_restrictions

string | null · maxLength: 1000

Access restrictions

Example: Access restricted to residents and authorized personnel only

emergency_contact

string | null · maxLength: 255

Emergency contact

Example: +33 1 23 45 67 89

notes

string | null · maxLength: 1000

Internal notes about the key

Example: Enhanced security key

Create a new key › Responses

Key created successfully

Key or access badge for a property

id

string · uuid · required

Unique key identifier

Example: 550e8400-e29b-41d4-a716-446655440000

tenant_id

string · required

Tenant ID (multi-tenant isolation)

Example: sjIXqWvUyablBYwvIuAeADRCJvGS9bTX

estate_id

string · uuid · required

Property ID

Example: 550e8400-e29b-41d4-a716-446655440001

key_type

string · enum · required

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

status

string · enum · required

Key status

Enum values:

ACTIVE

RENDERED

LOST

STOLEN

DAMAGED

REPLACED

ARCHIVED

Example: ACTIVE

security_level

string · enum · required

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

is_rendered

boolean · required

Indicates whether the key has been returned

Example: false

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 500

Key description

Example: Main key for the apartment

brand

string | null · maxLength: 100

Key or badge brand

Example: Serrurier Martin

key_number

string | null · maxLength: 100

Key or badge number

Example: KEY-001

quantity

integer | null · min: 1

Key quantity

Example: 2

protected_code

string | null · maxLength: 100

Key protection code

Example: ABC123

access_restrictions

string | null · maxLength: 1000

Access restrictions

Example: Access restricted to residents and authorized personnel only

emergency_contact

string | null · maxLength: 255

Emergency contact

Example: +33 1 23 45 67 89

notes

string | null · maxLength: 1000

Internal notes about the key

Example: Enhanced security key

rendered_to

string | null · maxLength: 255

Person to whom the key was handed over

Example: Jean Dupont

rendered_by

string | null · maxLength: 255

Person who handed over the key

Example: Marie Martin

rendered_at

string | null · date-time

Date and time when the key was handed over

Example: 2024-01-20T10:30:00Z

expected_return_date

string | null · date-time

Expected key return date

Example: 2024-01-25T18:00:00Z

purpose

string | null · maxLength: 500

Reason for handing over the key

Example: Apartment visit

last_status_change_at

string | null · date-time

Date and time of the last status change

Example: 2024-01-20T10:30:00Z

last_status_change_by

string | null · maxLength: 255

Person who made the last status change

Example: Marie Martin

POST/places/{place_id}/estates/{estate_id}/keys

curl --request POST \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "key_type": "CLEF",
  "description": "Main key for the apartment",
  "brand": "Locksmith Martin",
  "key_number": "KEY-001",
  "quantity": 2,
  "protected_code": "ABC123",
  "security_level": "STANDARD",
  "access_restrictions": "Access restricted to residents and authorized personnel only",
  "emergency_contact": "+33 1 23 45 67 89",
  "notes": "Reinforced security key"
}
'

shell

Example Request Body

{
  "key_type": "CLEF",
  "description": "Main key for the apartment",
  "brand": "Locksmith Martin",
  "key_number": "KEY-001",
  "quantity": 2,
  "protected_code": "ABC123",
  "security_level": "STANDARD",
  "access_restrictions": "Access restricted to residents and authorized personnel only",
  "emergency_contact": "+33 1 23 45 67 89",
  "notes": "Reinforced security key"
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "sjIXqWvUyablBYwvIuAeADRCJvGS9bTX",
  "estate_id": "550e8400-e29b-41d4-a716-446655440001",
  "key_type": "CLEF",
  "description": "Main key for the apartment",
  "brand": "Serrurier Martin",
  "key_number": "KEY-001",
  "quantity": 2,
  "protected_code": "ABC123",
  "status": "ACTIVE",
  "security_level": "STANDARD",
  "access_restrictions": "Access restricted to residents and authorized personnel only",
  "emergency_contact": "+33 1 23 45 67 89",
  "is_rendered": false,
  "notes": "Enhanced security key",
  "rendered_to": "Jean Dupont",
  "rendered_by": "Marie Martin",
  "rendered_at": "2024-01-20T10:30:00Z",
  "expected_return_date": "2024-01-25T18:00:00Z",
  "purpose": "Apartment visit",
  "last_status_change_at": "2024-01-20T10:30:00Z",
  "last_status_change_by": "Marie Martin",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Get key by ID

GET

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/keys/{key_id}

Retrieves the details of a specific key

Get key by ID › path Parameters

place_id

string · uuid · required

place ID

estate_id

string · uuid · required

property ID

key_id

string · uuid · required

key ID

Get key by ID › Responses

Key retrieved successfully

Key or access badge for a property

id

string · uuid · required

Unique key identifier

Example: 550e8400-e29b-41d4-a716-446655440000

tenant_id

string · required

Tenant ID (multi-tenant isolation)

Example: sjIXqWvUyablBYwvIuAeADRCJvGS9bTX

estate_id

string · uuid · required

Property ID

Example: 550e8400-e29b-41d4-a716-446655440001

key_type

string · enum · required

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

status

string · enum · required

Key status

Enum values:

ACTIVE

RENDERED

LOST

STOLEN

DAMAGED

REPLACED

ARCHIVED

Example: ACTIVE

security_level

string · enum · required

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

is_rendered

boolean · required

Indicates whether the key has been returned

Example: false

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 500

Key description

Example: Main key for the apartment

brand

string | null · maxLength: 100

Key or badge brand

Example: Serrurier Martin

key_number

string | null · maxLength: 100

Key or badge number

Example: KEY-001

quantity

integer | null · min: 1

Key quantity

Example: 2

protected_code

string | null · maxLength: 100

Key protection code

Example: ABC123

access_restrictions

string | null · maxLength: 1000

Access restrictions

Example: Access restricted to residents and authorized personnel only

emergency_contact

string | null · maxLength: 255

Emergency contact

Example: +33 1 23 45 67 89

notes

string | null · maxLength: 1000

Internal notes about the key

Example: Enhanced security key

rendered_to

string | null · maxLength: 255

Person to whom the key was handed over

Example: Jean Dupont

rendered_by

string | null · maxLength: 255

Person who handed over the key

Example: Marie Martin

rendered_at

string | null · date-time

Date and time when the key was handed over

Example: 2024-01-20T10:30:00Z

expected_return_date

string | null · date-time

Expected key return date

Example: 2024-01-25T18:00:00Z

purpose

string | null · maxLength: 500

Reason for handing over the key

Example: Apartment visit

last_status_change_at

string | null · date-time

Date and time of the last status change

Example: 2024-01-20T10:30:00Z

last_status_change_by

string | null · maxLength: 255

Person who made the last status change

Example: Marie Martin

GET/places/{place_id}/estates/{estate_id}/keys/{key_id}

curl --request GET \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/keys/:key_id

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "sjIXqWvUyablBYwvIuAeADRCJvGS9bTX",
  "estate_id": "550e8400-e29b-41d4-a716-446655440001",
  "key_type": "CLEF",
  "description": "Main key for the apartment",
  "brand": "Serrurier Martin",
  "key_number": "KEY-001",
  "quantity": 2,
  "protected_code": "ABC123",
  "status": "ACTIVE",
  "security_level": "STANDARD",
  "access_restrictions": "Access restricted to residents and authorized personnel only",
  "emergency_contact": "+33 1 23 45 67 89",
  "is_rendered": false,
  "notes": "Enhanced security key",
  "rendered_to": "Jean Dupont",
  "rendered_by": "Marie Martin",
  "rendered_at": "2024-01-20T10:30:00Z",
  "expected_return_date": "2024-01-25T18:00:00Z",
  "purpose": "Apartment visit",
  "last_status_change_at": "2024-01-20T10:30:00Z",
  "last_status_change_by": "Marie Martin",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Update key

PUT

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/keys/{key_id}

Updates the information of an existing key

Update key › path Parameters

place_id

string · uuid · required

place ID

estate_id

string · uuid · required

property ID

key_id

string · uuid · required

key ID

Update key › Request Body

Data for updating a key

key_type

string · enum

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

description

string | null · maxLength: 500

Key description

brand

string | null · maxLength: 100

Key or badge brand

key_number

string | null · maxLength: 100

Key or badge number

quantity

integer | null · min: 1

Key quantity

protected_code

string | null · maxLength: 100

Key protection code

security_level

string · enum

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

access_restrictions

string | null · maxLength: 1000

Access restrictions

emergency_contact

string | null · maxLength: 255

Emergency contact

notes

string | null · maxLength: 1000

Internal notes about the key

Update key › Responses

Key updated successfully

Key or access badge for a property

id

string · uuid · required

Unique key identifier

Example: 550e8400-e29b-41d4-a716-446655440000

tenant_id

string · required

Tenant ID (multi-tenant isolation)

Example: sjIXqWvUyablBYwvIuAeADRCJvGS9bTX

estate_id

string · uuid · required

Property ID

Example: 550e8400-e29b-41d4-a716-446655440001

key_type

string · enum · required

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

status

string · enum · required

Key status

Enum values:

ACTIVE

RENDERED

LOST

STOLEN

DAMAGED

REPLACED

ARCHIVED

Example: ACTIVE

security_level

string · enum · required

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

is_rendered

boolean · required

Indicates whether the key has been returned

Example: false

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 500

Key description

Example: Main key for the apartment

brand

string | null · maxLength: 100

Key or badge brand

Example: Serrurier Martin

key_number

string | null · maxLength: 100

Key or badge number

Example: KEY-001

quantity

integer | null · min: 1

Key quantity

Example: 2

protected_code

string | null · maxLength: 100

Key protection code

Example: ABC123

access_restrictions

string | null · maxLength: 1000

Access restrictions

Example: Access restricted to residents and authorized personnel only

emergency_contact

string | null · maxLength: 255

Emergency contact

Example: +33 1 23 45 67 89

notes

string | null · maxLength: 1000

Internal notes about the key

Example: Enhanced security key

rendered_to

string | null · maxLength: 255

Person to whom the key was handed over

Example: Jean Dupont

rendered_by

string | null · maxLength: 255

Person who handed over the key

Example: Marie Martin

rendered_at

string | null · date-time

Date and time when the key was handed over

Example: 2024-01-20T10:30:00Z

expected_return_date

string | null · date-time

Expected key return date

Example: 2024-01-25T18:00:00Z

purpose

string | null · maxLength: 500

Reason for handing over the key

Example: Apartment visit

last_status_change_at

string | null · date-time

Date and time of the last status change

Example: 2024-01-20T10:30:00Z

last_status_change_by

string | null · maxLength: 255

Person who made the last status change

Example: Marie Martin

PUT/places/{place_id}/estates/{estate_id}/keys/{key_id}

curl --request PUT \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/keys/:key_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Main key for the apartment (updated)",
  "security_level": "HIGH"
}
'

shell

Example Request Body

{
  "description": "Main key for the apartment (updated)",
  "security_level": "HIGH"
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "sjIXqWvUyablBYwvIuAeADRCJvGS9bTX",
  "estate_id": "550e8400-e29b-41d4-a716-446655440001",
  "key_type": "CLEF",
  "description": "Main key for the apartment",
  "brand": "Serrurier Martin",
  "key_number": "KEY-001",
  "quantity": 2,
  "protected_code": "ABC123",
  "status": "ACTIVE",
  "security_level": "STANDARD",
  "access_restrictions": "Access restricted to residents and authorized personnel only",
  "emergency_contact": "+33 1 23 45 67 89",
  "is_rendered": false,
  "notes": "Enhanced security key",
  "rendered_to": "Jean Dupont",
  "rendered_by": "Marie Martin",
  "rendered_at": "2024-01-20T10:30:00Z",
  "expected_return_date": "2024-01-25T18:00:00Z",
  "purpose": "Apartment visit",
  "last_status_change_at": "2024-01-20T10:30:00Z",
  "last_status_change_by": "Marie Martin",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Delete key

DELETE

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/keys/{key_id}

Deletes a key from the system

Delete key › path Parameters

place_id

string · uuid · required

place ID

estate_id

string · uuid · required

property ID

key_id

string · uuid · required

key ID

Delete key › Responses

Key deleted successfully

No data returned

DELETE/places/{place_id}/estates/{estate_id}/keys/{key_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/keys/:key_id

shell

Example Responses

No example specified for this content type

Hand over a key

POST

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/keys/{key_id}/render

Marks a key as handed over with full traceability

Hand over a key › path Parameters

place_id

string · uuid · required

place ID

estate_id

string · uuid · required

property ID

key_id

string · uuid · required

key ID

Hand over a key › Request Body

Data for handing over a key

rendered_to

string · maxLength: 255 · required

Person to whom the key is handed over

Example: Jean Dupont

rendered_by

string · maxLength: 255 · required

Person who hands over the key

Example: Marie Martin

rendered_at

string | null · date-time

Date and time of handover (default: now)

Example: 2024-01-20T10:30:00Z

expected_return_date

string | null · date-time

Expected return date

Example: 2024-01-25T18:00:00Z

purpose

string | null · maxLength: 500

Reason for handover

Example: Apartment visit

notes

string | null · maxLength: 1000

Internal notes

Example: Key handed over for visit with potential tenant

Hand over a key › Responses

Key handed over successfully

Key or access badge for a property

id

string · uuid · required

Unique key identifier

Example: 550e8400-e29b-41d4-a716-446655440000

tenant_id

string · required

Tenant ID (multi-tenant isolation)

Example: sjIXqWvUyablBYwvIuAeADRCJvGS9bTX

estate_id

string · uuid · required

Property ID

Example: 550e8400-e29b-41d4-a716-446655440001

key_type

string · enum · required

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

status

string · enum · required

Key status

Enum values:

ACTIVE

RENDERED

LOST

STOLEN

DAMAGED

REPLACED

ARCHIVED

Example: ACTIVE

security_level

string · enum · required

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

is_rendered

boolean · required

Indicates whether the key has been returned

Example: false

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 500

Key description

Example: Main key for the apartment

brand

string | null · maxLength: 100

Key or badge brand

Example: Serrurier Martin

key_number

string | null · maxLength: 100

Key or badge number

Example: KEY-001

quantity

integer | null · min: 1

Key quantity

Example: 2

protected_code

string | null · maxLength: 100

Key protection code

Example: ABC123

access_restrictions

string | null · maxLength: 1000

Access restrictions

Example: Access restricted to residents and authorized personnel only

emergency_contact

string | null · maxLength: 255

Emergency contact

Example: +33 1 23 45 67 89

notes

string | null · maxLength: 1000

Internal notes about the key

Example: Enhanced security key

rendered_to

string | null · maxLength: 255

Person to whom the key was handed over

Example: Jean Dupont

rendered_by

string | null · maxLength: 255

Person who handed over the key

Example: Marie Martin

rendered_at

string | null · date-time

Date and time when the key was handed over

Example: 2024-01-20T10:30:00Z

expected_return_date

string | null · date-time

Expected key return date

Example: 2024-01-25T18:00:00Z

purpose

string | null · maxLength: 500

Reason for handing over the key

Example: Apartment visit

last_status_change_at

string | null · date-time

Date and time of the last status change

Example: 2024-01-20T10:30:00Z

last_status_change_by

string | null · maxLength: 255

Person who made the last status change

Example: Marie Martin

POST/places/{place_id}/estates/{estate_id}/keys/{key_id}/render

curl --request POST \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/keys/:key_id/render \
  --header 'Content-Type: application/json' \
  --data '
{
  "rendered_to": "Jean Dupont",
  "rendered_by": "Marie Martin",
  "rendered_at": "2024-01-20T10:30:00Z",
  "expected_return_date": "2024-01-25T18:00:00Z",
  "purpose": "Apartment visit",
  "notes": "Key handed over for visit with potential tenant"
}
'

shell

Example Request Body

{
  "rendered_to": "Jean Dupont",
  "rendered_by": "Marie Martin",
  "rendered_at": "2024-01-20T10:30:00Z",
  "expected_return_date": "2024-01-25T18:00:00Z",
  "purpose": "Apartment visit",
  "notes": "Key handed over for visit with potential tenant"
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "sjIXqWvUyablBYwvIuAeADRCJvGS9bTX",
  "estate_id": "550e8400-e29b-41d4-a716-446655440001",
  "key_type": "CLEF",
  "description": "Main key for the apartment",
  "brand": "Serrurier Martin",
  "key_number": "KEY-001",
  "quantity": 2,
  "protected_code": "ABC123",
  "status": "ACTIVE",
  "security_level": "STANDARD",
  "access_restrictions": "Access restricted to residents and authorized personnel only",
  "emergency_contact": "+33 1 23 45 67 89",
  "is_rendered": false,
  "notes": "Enhanced security key",
  "rendered_to": "Jean Dupont",
  "rendered_by": "Marie Martin",
  "rendered_at": "2024-01-20T10:30:00Z",
  "expected_return_date": "2024-01-25T18:00:00Z",
  "purpose": "Apartment visit",
  "last_status_change_at": "2024-01-20T10:30:00Z",
  "last_status_change_by": "Marie Martin",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Return a key

POST

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/keys/{key_id}/return

Marks a key as returned (status ACTIVE)

Return a key › path Parameters

place_id

string · uuid · required

place ID

estate_id

string · uuid · required

property ID

key_id

string · uuid · required

key ID

Return a key › Request Body

Data for returning a key

returned_by

string · maxLength: 255 · required

Person who returns the key

Example: Jean Dupont

notes

string | null · maxLength: 1000

Notes about the return

Example: Key returned in good condition

Return a key › Responses

Key returned successfully

Key or access badge for a property

id

string · uuid · required

Unique key identifier

Example: 550e8400-e29b-41d4-a716-446655440000

tenant_id

string · required

Tenant ID (multi-tenant isolation)

Example: sjIXqWvUyablBYwvIuAeADRCJvGS9bTX

estate_id

string · uuid · required

Property ID

Example: 550e8400-e29b-41d4-a716-446655440001

key_type

string · enum · required

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

status

string · enum · required

Key status

Enum values:

ACTIVE

RENDERED

LOST

STOLEN

DAMAGED

REPLACED

ARCHIVED

Example: ACTIVE

security_level

string · enum · required

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

is_rendered

boolean · required

Indicates whether the key has been returned

Example: false

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 500

Key description

Example: Main key for the apartment

brand

string | null · maxLength: 100

Key or badge brand

Example: Serrurier Martin

key_number

string | null · maxLength: 100

Key or badge number

Example: KEY-001

quantity

integer | null · min: 1

Key quantity

Example: 2

protected_code

string | null · maxLength: 100

Key protection code

Example: ABC123

access_restrictions

string | null · maxLength: 1000

Access restrictions

Example: Access restricted to residents and authorized personnel only

emergency_contact

string | null · maxLength: 255

Emergency contact

Example: +33 1 23 45 67 89

notes

string | null · maxLength: 1000

Internal notes about the key

Example: Enhanced security key

rendered_to

string | null · maxLength: 255

Person to whom the key was handed over

Example: Jean Dupont

rendered_by

string | null · maxLength: 255

Person who handed over the key

Example: Marie Martin

rendered_at

string | null · date-time

Date and time when the key was handed over

Example: 2024-01-20T10:30:00Z

expected_return_date

string | null · date-time

Expected key return date

Example: 2024-01-25T18:00:00Z

purpose

string | null · maxLength: 500

Reason for handing over the key

Example: Apartment visit

last_status_change_at

string | null · date-time

Date and time of the last status change

Example: 2024-01-20T10:30:00Z

last_status_change_by

string | null · maxLength: 255

Person who made the last status change

Example: Marie Martin

POST/places/{place_id}/estates/{estate_id}/keys/{key_id}/return

curl --request POST \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/keys/:key_id/return \
  --header 'Content-Type: application/json' \
  --data '
{
  "returned_by": "Jean Dupont",
  "notes": "Key returned in good condition"
}
'

shell

Example Request Body

{
  "returned_by": "Jean Dupont",
  "notes": "Key returned in good condition"
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "sjIXqWvUyablBYwvIuAeADRCJvGS9bTX",
  "estate_id": "550e8400-e29b-41d4-a716-446655440001",
  "key_type": "CLEF",
  "description": "Main key for the apartment",
  "brand": "Serrurier Martin",
  "key_number": "KEY-001",
  "quantity": 2,
  "protected_code": "ABC123",
  "status": "ACTIVE",
  "security_level": "STANDARD",
  "access_restrictions": "Access restricted to residents and authorized personnel only",
  "emergency_contact": "+33 1 23 45 67 89",
  "is_rendered": false,
  "notes": "Enhanced security key",
  "rendered_to": "Jean Dupont",
  "rendered_by": "Marie Martin",
  "rendered_at": "2024-01-20T10:30:00Z",
  "expected_return_date": "2024-01-25T18:00:00Z",
  "purpose": "Apartment visit",
  "last_status_change_at": "2024-01-20T10:30:00Z",
  "last_status_change_by": "Marie Martin",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Mark a key as lost

POST

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/keys/{key_id}/lost

Marks a key as lost (status LOST)

Mark a key as lost › path Parameters

place_id

string · uuid · required

place ID

estate_id

string · uuid · required

property ID

key_id

string · uuid · required

key ID

Mark a key as lost › Request Body

Data for marking a key as lost

changed_by

string · maxLength: 255 · required

Person who marks the key as lost

Example: Marie Martin

notes

string | null · maxLength: 1000

Notes about the loss

Example: Key misplaced during the visit - Search in progress

Mark a key as lost › Responses

Key marked as lost successfully

Key or access badge for a property

id

string · uuid · required

Unique key identifier

Example: 550e8400-e29b-41d4-a716-446655440000

tenant_id

string · required

Tenant ID (multi-tenant isolation)

Example: sjIXqWvUyablBYwvIuAeADRCJvGS9bTX

estate_id

string · uuid · required

Property ID

Example: 550e8400-e29b-41d4-a716-446655440001

key_type

string · enum · required

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

status

string · enum · required

Key status

Enum values:

ACTIVE

RENDERED

LOST

STOLEN

DAMAGED

REPLACED

ARCHIVED

Example: ACTIVE

security_level

string · enum · required

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

is_rendered

boolean · required

Indicates whether the key has been returned

Example: false

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 500

Key description

Example: Main key for the apartment

brand

string | null · maxLength: 100

Key or badge brand

Example: Serrurier Martin

key_number

string | null · maxLength: 100

Key or badge number

Example: KEY-001

quantity

integer | null · min: 1

Key quantity

Example: 2

protected_code

string | null · maxLength: 100

Key protection code

Example: ABC123

access_restrictions

string | null · maxLength: 1000

Access restrictions

Example: Access restricted to residents and authorized personnel only

emergency_contact

string | null · maxLength: 255

Emergency contact

Example: +33 1 23 45 67 89

notes

string | null · maxLength: 1000

Internal notes about the key

Example: Enhanced security key

rendered_to

string | null · maxLength: 255

Person to whom the key was handed over

Example: Jean Dupont

rendered_by

string | null · maxLength: 255

Person who handed over the key

Example: Marie Martin

rendered_at

string | null · date-time

Date and time when the key was handed over

Example: 2024-01-20T10:30:00Z

expected_return_date

string | null · date-time

Expected key return date

Example: 2024-01-25T18:00:00Z

purpose

string | null · maxLength: 500

Reason for handing over the key

Example: Apartment visit

last_status_change_at

string | null · date-time

Date and time of the last status change

Example: 2024-01-20T10:30:00Z

last_status_change_by

string | null · maxLength: 255

Person who made the last status change

Example: Marie Martin

POST/places/{place_id}/estates/{estate_id}/keys/{key_id}/lost

curl --request POST \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/keys/:key_id/lost \
  --header 'Content-Type: application/json' \
  --data '
{
  "changed_by": "Marie Martin",
  "notes": "Key lost during the visit - Search in progress"
}
'

shell

Example Request Body

{
  "changed_by": "Marie Martin",
  "notes": "Key lost during the visit - Search in progress"
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "sjIXqWvUyablBYwvIuAeADRCJvGS9bTX",
  "estate_id": "550e8400-e29b-41d4-a716-446655440001",
  "key_type": "CLEF",
  "description": "Main key for the apartment",
  "brand": "Serrurier Martin",
  "key_number": "KEY-001",
  "quantity": 2,
  "protected_code": "ABC123",
  "status": "ACTIVE",
  "security_level": "STANDARD",
  "access_restrictions": "Access restricted to residents and authorized personnel only",
  "emergency_contact": "+33 1 23 45 67 89",
  "is_rendered": false,
  "notes": "Enhanced security key",
  "rendered_to": "Jean Dupont",
  "rendered_by": "Marie Martin",
  "rendered_at": "2024-01-20T10:30:00Z",
  "expected_return_date": "2024-01-25T18:00:00Z",
  "purpose": "Apartment visit",
  "last_status_change_at": "2024-01-20T10:30:00Z",
  "last_status_change_by": "Marie Martin",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Mark a key as found

POST

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/keys/{key_id}/found

Marks a lost key as found (status ACTIVE)

Mark a key as found › path Parameters

place_id

string · uuid · required

place ID

estate_id

string · uuid · required

property ID

key_id

string · uuid · required

key ID

Mark a key as found › Request Body

Data for marking a key as found

found_by

string · maxLength: 255 · required

Person who found the key

Example: Jean Dupont

notes

string | null · maxLength: 1000

Notes about the discovery

Example: Key found in the office

Mark a key as found › Responses

Key marked as found successfully

Key or access badge for a property

id

string · uuid · required

Unique key identifier

Example: 550e8400-e29b-41d4-a716-446655440000

tenant_id

string · required

Tenant ID (multi-tenant isolation)

Example: sjIXqWvUyablBYwvIuAeADRCJvGS9bTX

estate_id

string · uuid · required

Property ID

Example: 550e8400-e29b-41d4-a716-446655440001

key_type

string · enum · required

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

status

string · enum · required

Key status

Enum values:

ACTIVE

RENDERED

LOST

STOLEN

DAMAGED

REPLACED

ARCHIVED

Example: ACTIVE

security_level

string · enum · required

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

is_rendered

boolean · required

Indicates whether the key has been returned

Example: false

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 500

Key description

Example: Main key for the apartment

brand

string | null · maxLength: 100

Key or badge brand

Example: Serrurier Martin

key_number

string | null · maxLength: 100

Key or badge number

Example: KEY-001

quantity

integer | null · min: 1

Key quantity

Example: 2

protected_code

string | null · maxLength: 100

Key protection code

Example: ABC123

access_restrictions

string | null · maxLength: 1000

Access restrictions

Example: Access restricted to residents and authorized personnel only

emergency_contact

string | null · maxLength: 255

Emergency contact

Example: +33 1 23 45 67 89

notes

string | null · maxLength: 1000

Internal notes about the key

Example: Enhanced security key

rendered_to

string | null · maxLength: 255

Person to whom the key was handed over

Example: Jean Dupont

rendered_by

string | null · maxLength: 255

Person who handed over the key

Example: Marie Martin

rendered_at

string | null · date-time

Date and time when the key was handed over

Example: 2024-01-20T10:30:00Z

expected_return_date

string | null · date-time

Expected key return date

Example: 2024-01-25T18:00:00Z

purpose

string | null · maxLength: 500

Reason for handing over the key

Example: Apartment visit

last_status_change_at

string | null · date-time

Date and time of the last status change

Example: 2024-01-20T10:30:00Z

last_status_change_by

string | null · maxLength: 255

Person who made the last status change

Example: Marie Martin

POST/places/{place_id}/estates/{estate_id}/keys/{key_id}/found

curl --request POST \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/keys/:key_id/found \
  --header 'Content-Type: application/json' \
  --data '
{
  "found_by": "Jean Dupont",
  "notes": "Key found in the office"
}
'

shell

Example Request Body

{
  "found_by": "Jean Dupont",
  "notes": "Key found in the office"
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "sjIXqWvUyablBYwvIuAeADRCJvGS9bTX",
  "estate_id": "550e8400-e29b-41d4-a716-446655440001",
  "key_type": "CLEF",
  "description": "Main key for the apartment",
  "brand": "Serrurier Martin",
  "key_number": "KEY-001",
  "quantity": 2,
  "protected_code": "ABC123",
  "status": "ACTIVE",
  "security_level": "STANDARD",
  "access_restrictions": "Access restricted to residents and authorized personnel only",
  "emergency_contact": "+33 1 23 45 67 89",
  "is_rendered": false,
  "notes": "Enhanced security key",
  "rendered_to": "Jean Dupont",
  "rendered_by": "Marie Martin",
  "rendered_at": "2024-01-20T10:30:00Z",
  "expected_return_date": "2024-01-25T18:00:00Z",
  "purpose": "Apartment visit",
  "last_status_change_at": "2024-01-20T10:30:00Z",
  "last_status_change_by": "Marie Martin",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Mark a key as damaged

POST

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/keys/{key_id}/damaged

Marks a key as damaged (status DAMAGED)

Mark a key as damaged › path Parameters

place_id

string · uuid · required

place ID

estate_id

string · uuid · required

property ID

key_id

string · uuid · required

key ID

Mark a key as damaged › Request Body

Data for marking a key as damaged

changed_by

string · maxLength: 255 · required

Person who marks the key as damaged

Example: Marie Martin

notes

string | null · maxLength: 1000

Notes about the damage

Example: Key broken during use

Mark a key as damaged › Responses

Key marked as damaged successfully

Key or access badge for a property

id

string · uuid · required

Unique key identifier

Example: 550e8400-e29b-41d4-a716-446655440000

tenant_id

string · required

Tenant ID (multi-tenant isolation)

Example: sjIXqWvUyablBYwvIuAeADRCJvGS9bTX

estate_id

string · uuid · required

Property ID

Example: 550e8400-e29b-41d4-a716-446655440001

key_type

string · enum · required

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

status

string · enum · required

Key status

Enum values:

ACTIVE

RENDERED

LOST

STOLEN

DAMAGED

REPLACED

ARCHIVED

Example: ACTIVE

security_level

string · enum · required

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

is_rendered

boolean · required

Indicates whether the key has been returned

Example: false

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 500

Key description

Example: Main key for the apartment

brand

string | null · maxLength: 100

Key or badge brand

Example: Serrurier Martin

key_number

string | null · maxLength: 100

Key or badge number

Example: KEY-001

quantity

integer | null · min: 1

Key quantity

Example: 2

protected_code

string | null · maxLength: 100

Key protection code

Example: ABC123

access_restrictions

string | null · maxLength: 1000

Access restrictions

Example: Access restricted to residents and authorized personnel only

emergency_contact

string | null · maxLength: 255

Emergency contact

Example: +33 1 23 45 67 89

notes

string | null · maxLength: 1000

Internal notes about the key

Example: Enhanced security key

rendered_to

string | null · maxLength: 255

Person to whom the key was handed over

Example: Jean Dupont

rendered_by

string | null · maxLength: 255

Person who handed over the key

Example: Marie Martin

rendered_at

string | null · date-time

Date and time when the key was handed over

Example: 2024-01-20T10:30:00Z

expected_return_date

string | null · date-time

Expected key return date

Example: 2024-01-25T18:00:00Z

purpose

string | null · maxLength: 500

Reason for handing over the key

Example: Apartment visit

last_status_change_at

string | null · date-time

Date and time of the last status change

Example: 2024-01-20T10:30:00Z

last_status_change_by

string | null · maxLength: 255

Person who made the last status change

Example: Marie Martin

POST/places/{place_id}/estates/{estate_id}/keys/{key_id}/damaged

curl --request POST \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/keys/:key_id/damaged \
  --header 'Content-Type: application/json' \
  --data '
{
  "changed_by": "Marie Martin",
  "notes": "Key broken during use"
}
'

shell

Example Request Body

{
  "changed_by": "Marie Martin",
  "notes": "Key broken during use"
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "sjIXqWvUyablBYwvIuAeADRCJvGS9bTX",
  "estate_id": "550e8400-e29b-41d4-a716-446655440001",
  "key_type": "CLEF",
  "description": "Main key for the apartment",
  "brand": "Serrurier Martin",
  "key_number": "KEY-001",
  "quantity": 2,
  "protected_code": "ABC123",
  "status": "ACTIVE",
  "security_level": "STANDARD",
  "access_restrictions": "Access restricted to residents and authorized personnel only",
  "emergency_contact": "+33 1 23 45 67 89",
  "is_rendered": false,
  "notes": "Enhanced security key",
  "rendered_to": "Jean Dupont",
  "rendered_by": "Marie Martin",
  "rendered_at": "2024-01-20T10:30:00Z",
  "expected_return_date": "2024-01-25T18:00:00Z",
  "purpose": "Apartment visit",
  "last_status_change_at": "2024-01-20T10:30:00Z",
  "last_status_change_by": "Marie Martin",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Archive a key

POST

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/keys/{key_id}/archive

Archives a key (status ARCHIVED)

Archive a key › path Parameters

place_id

string · uuid · required

place ID

estate_id

string · uuid · required

property ID

key_id

string · uuid · required

key ID

Archive a key › Request Body

Data for archiving a key

archived_by

string · maxLength: 255 · required

Person who archives the key

Example: Marie Martin

notes

string | null · maxLength: 1000

Notes about the archival

Example: Key replaced by a new one

Archive a key › Responses

Key archived successfully

Key or access badge for a property

id

string · uuid · required

Unique key identifier

Example: 550e8400-e29b-41d4-a716-446655440000

tenant_id

string · required

Tenant ID (multi-tenant isolation)

Example: sjIXqWvUyablBYwvIuAeADRCJvGS9bTX

estate_id

string · uuid · required

Property ID

Example: 550e8400-e29b-41d4-a716-446655440001

key_type

string · enum · required

Key or access badge type

Enum values:

CLEF

BADGE_MAGNETIQUE

BADGE_RF

BIOMETRIQUE

CLEF_DUPLIQUEE

TELECOMMANDE

Example: CLEF

status

string · enum · required

Key status

Enum values:

ACTIVE

RENDERED

LOST

STOLEN

DAMAGED

REPLACED

ARCHIVED

Example: ACTIVE

security_level

string · enum · required

Key security level

Enum values:

LOW

STANDARD

MEDIUM

HIGH

CRITICAL

Example: STANDARD

is_rendered

boolean · required

Indicates whether the key has been returned

Example: false

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null · maxLength: 500

Key description

Example: Main key for the apartment

brand

string | null · maxLength: 100

Key or badge brand

Example: Serrurier Martin

key_number

string | null · maxLength: 100

Key or badge number

Example: KEY-001

quantity

integer | null · min: 1

Key quantity

Example: 2

protected_code

string | null · maxLength: 100

Key protection code

Example: ABC123

access_restrictions

string | null · maxLength: 1000

Access restrictions

Example: Access restricted to residents and authorized personnel only

emergency_contact

string | null · maxLength: 255

Emergency contact

Example: +33 1 23 45 67 89

notes

string | null · maxLength: 1000

Internal notes about the key

Example: Enhanced security key

rendered_to

string | null · maxLength: 255

Person to whom the key was handed over

Example: Jean Dupont

rendered_by

string | null · maxLength: 255

Person who handed over the key

Example: Marie Martin

rendered_at

string | null · date-time

Date and time when the key was handed over

Example: 2024-01-20T10:30:00Z

expected_return_date

string | null · date-time

Expected key return date

Example: 2024-01-25T18:00:00Z

purpose

string | null · maxLength: 500

Reason for handing over the key

Example: Apartment visit

last_status_change_at

string | null · date-time

Date and time of the last status change

Example: 2024-01-20T10:30:00Z

last_status_change_by

string | null · maxLength: 255

Person who made the last status change

Example: Marie Martin

POST/places/{place_id}/estates/{estate_id}/keys/{key_id}/archive

curl --request POST \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/keys/:key_id/archive \
  --header 'Content-Type: application/json' \
  --data '
{
  "archived_by": "Marie Martin",
  "notes": "Key replaced with a new one"
}
'

shell

Example Request Body

{
  "archived_by": "Marie Martin",
  "notes": "Key replaced with a new one"
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "sjIXqWvUyablBYwvIuAeADRCJvGS9bTX",
  "estate_id": "550e8400-e29b-41d4-a716-446655440001",
  "key_type": "CLEF",
  "description": "Main key for the apartment",
  "brand": "Serrurier Martin",
  "key_number": "KEY-001",
  "quantity": 2,
  "protected_code": "ABC123",
  "status": "ACTIVE",
  "security_level": "STANDARD",
  "access_restrictions": "Access restricted to residents and authorized personnel only",
  "emergency_contact": "+33 1 23 45 67 89",
  "is_rendered": false,
  "notes": "Enhanced security key",
  "rendered_to": "Jean Dupont",
  "rendered_by": "Marie Martin",
  "rendered_at": "2024-01-20T10:30:00Z",
  "expected_return_date": "2024-01-25T18:00:00Z",
  "purpose": "Apartment visit",
  "last_status_change_at": "2024-01-20T10:30:00Z",
  "last_status_change_by": "Marie Martin",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Inventory Types