FairePlace Property Management API

Templates

Endpointhttps://api.faireplace.com/api

List templates for a lease type

GET

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates

Retrieve all templates associated with a lease type

List templates for a lease type › path Parameters

lease_type_id

string · uuid · required

Lease type ID

List templates for a lease type › Responses

Templates retrieved successfully

object[]

Lease type template

id

string · uuid · required

Unique identifier of the template

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

lease_type_id

string · uuid · required

Lease type ID

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

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

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: 1000

Template description

Example: Standard template for furnished leases

GET/lease-types/{lease_type_id}/templates

curl --request GET \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Standard furnished lease template",
    "description": "Standard template for furnished leases",
    "content": "#= Furnished lease\n\nLease entered into between...",
    "template_type": "lease",
    "version": "1.0.0",
    "is_active": true,
    "is_default": false,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

Create a template for a lease type

POST

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates

Create a new template for a lease type

Create a template for a lease type › path Parameters

lease_type_id

string · uuid · required

Lease type ID

Create a template for a lease type › Request Body

Data for creating a new lease type template

name

string · minLength: 1 · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · minLength: 1 · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · minLength: 1 · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

Example: false

description

string | null · maxLength: 1000

Template description

Example: Standard template for furnished leases

Create a template for a lease type › Responses

Template created successfully

Lease type template

id

string · uuid · required

Unique identifier of the template

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

lease_type_id

string · uuid · required

Lease type ID

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

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

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: 1000

Template description

Example: Standard template for furnished leases

POST/lease-types/{lease_type_id}/templates

curl --request POST \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false
}
'

shell

Example Request Body

{
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

List templates by type

GET

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates/type/{type}

Retrieve all templates of a specific type for a lease type

List templates by type › path Parameters

lease_type_id

string · uuid · required

Lease type ID

type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

List templates by type › Responses

Templates retrieved successfully

object[]

Lease type template

id

string · uuid · required

Unique identifier of the template

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

lease_type_id

string · uuid · required

Lease type ID

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

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

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: 1000

Template description

Example: Standard template for furnished leases

GET/lease-types/{lease_type_id}/templates/type/{type}

curl --request GET \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates/type/:type

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Standard furnished lease template",
    "description": "Standard template for furnished leases",
    "content": "#= Furnished lease\n\nLease entered into between...",
    "template_type": "lease",
    "version": "1.0.0",
    "is_active": true,
    "is_default": false,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

Get active template by type

GET

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates/active/{type}

Retrieve the active template of a specific type for a lease type

Get active template by type › path Parameters

lease_type_id

string · uuid · required

Lease type ID

type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Get active template by type › Responses

Active template retrieved successfully

Lease type template

id

string · uuid · required

Unique identifier of the template

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

lease_type_id

string · uuid · required

Lease type ID

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

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

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: 1000

Template description

Example: Standard template for furnished leases

GET/lease-types/{lease_type_id}/templates/active/{type}

curl --request GET \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates/active/:type

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Get default template by type

GET

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates/default/{type}

Retrieve the default template of a specific type for a lease type

Get default template by type › path Parameters

lease_type_id

string · uuid · required

Lease type ID

type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Get default template by type › Responses

Default template retrieved successfully

Lease type template

id

string · uuid · required

Unique identifier of the template

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

lease_type_id

string · uuid · required

Lease type ID

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

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

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: 1000

Template description

Example: Standard template for furnished leases

GET/lease-types/{lease_type_id}/templates/default/{type}

curl --request GET \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates/default/:type

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Get specific template

GET

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates/{template_id}

Retrieve the details of a specific template

Get specific template › path Parameters

lease_type_id

string · uuid · required

Lease type ID

template_id

string · uuid · required

Template ID

Get specific template › Responses

Template retrieved successfully

Lease type template

id

string · uuid · required

Unique identifier of the template

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

lease_type_id

string · uuid · required

Lease type ID

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

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

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: 1000

Template description

Example: Standard template for furnished leases

GET/lease-types/{lease_type_id}/templates/{template_id}

curl --request GET \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates/:template_id

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Update template

PUT

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates/{template_id}

Update an existing template

Update template › path Parameters

lease_type_id

string · uuid · required

Lease type ID

template_id

string · uuid · required

Template ID

Update template › Request Body

Data for updating a lease type template

name

string · minLength: 1 · maxLength: 255

Template name

Example: Standard furnished lease template

description

string | null · maxLength: 1000

Template description

Example: Standard template for furnished leases

content

string · minLength: 1

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · minLength: 1 · maxLength: 50

Template version

Example: 1.0.0

is_active

boolean

Indicates whether the template is active

Example: true

is_default

boolean

Indicates whether the template is the default

Example: false

Update template › Responses

Template updated successfully

Lease type template

id

string · uuid · required

Unique identifier of the template

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

lease_type_id

string · uuid · required

Lease type ID

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

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

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: 1000

Template description

Example: Standard template for furnished leases

PUT/lease-types/{lease_type_id}/templates/{template_id}

curl --request PUT \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates/:template_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false
}
'

shell

Example Request Body

{
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Delete template

DELETE

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates/{template_id}

Delete a template

Delete template › path Parameters

lease_type_id

string · uuid · required

Lease type ID

template_id

string · uuid · required

Template ID

Delete template › Responses

Template deleted successfully

No data returned

DELETE/lease-types/{lease_type_id}/templates/{template_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates/:template_id

shell

Example Responses

No example specified for this content type

Configurations Charge Configuration