Keys

List keys for a property

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

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

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/places/{place_id}/estates/{estate_id}/keys
  • Auth: HTTP bearer

Path parameters

place_idstring uuid required

place ID

estate_idstring uuid required

property ID

Query parameters

key_type'CLEF' | 'BADGE_MAGNETIQUE' | 'BADGE_RF' | 'BIOMETRIQUE' | 'CLEF_DUPLIQUEE' | 'TELECOMMANDE'

Key or access badge type

Example:CLEF

Filter by key type

status'ACTIVE' | 'RENDERED' | 'LOST' | 'STOLEN' | 'DAMAGED' | 'REPLACED' | 'ARCHIVED'

Key status

Example:ACTIVE

Filter by status

security_level'LOW' | 'STANDARD' | 'MEDIUM' | 'HIGH' | 'CRITICAL'

Key security level

Example:STANDARD

Filter by security level

is_renderedboolean

Filter by keys handed over/not handed over

brandstring

Filter by brand

pageinteger

Page number (default: 1)

limitinteger

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

Response

Keys list retrieved successfully

totalinteger required

Total number of keys

pageinteger required

Current page number

limitinteger required

Number of items per page

Example response

{
  "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",
      "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
}

Changes

No recorded changes to this operation across all 1 revision of this API.