FairePlace

FairePlace Amendment Notifications API

Notifications sent about an amendment.

Documentation GitHub OpenAPI

Operations 4

GET /leases/{lease_id}/amendments/{amendment_id}/notifications List notifications for an amendment #

GET /leases/{lease_id}/amendments/{amendment_id}/notifications/{notification_id} Get a specific notification #

PUT /leases/{lease_id}/amendments/{amendment_id}/notifications/{notification_id} Update notification status #

DELETE /leases/{lease_id}/amendments/{amendment_id}/notifications/{notification_id} Delete a notification #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/faireplace-com/openapi/faireplace-com-amendment-notifications-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/faireplace-com:faireplace-com-amendment-notifications-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: FairePlace Property Management Amendment Notifications API
  description: 'Comprehensive API for managing properties, leases, tenants, and all aspects of real estate management.

    Built with Rust and Actix-web following hexagonal architecture principles.


    ## Authentication

    This API uses API keys for authentication with tenant-based isolation.


    ## Base URL

    - Production: `https://api.faireplace.com/api`'
  version: 1.0.0
  contact:
    name: FairePlace API Support
    email: api-support@faireplace.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
- url: https://api.faireplace.com/api
  description: Production server
security:
- BearerAuth: []
tags:
- name: Amendment Notifications
  description: Notifications sent about an amendment.
paths:
  /leases/{lease_id}/amendments/{amendment_id}/notifications:
    get:
      operationId: listAmendmentNotifications
      summary: List notifications for an amendment
      description: Returns all notifications associated with a specific amendment.
      tags:
      - Amendment Notifications
      parameters:
      - name: lease_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: amendment_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: List of notifications
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AmendmentNotificationResponse'
        '401':
          description: Unauthorized
        '404':
          description: Amendment not found
  /leases/{lease_id}/amendments/{amendment_id}/notifications/{notification_id}:
    get:
      operationId: getAmendmentNotification
      summary: Get a specific notification
      description: Returns details of a single amendment notification.
      tags:
      - Amendment Notifications
      parameters:
      - name: lease_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: amendment_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: notification_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Notification details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmendmentNotificationResponse'
        '401':
          description: Unauthorized
        '404':
          description: Notification not found
    put:
      operationId: updateAmendmentNotificationStatus
      summary: Update notification status
      description: 'Update the status of an amendment notification (e.g., mark as read or actioned).

        Status transitions automatically set the corresponding timestamp (sent_date, read_date, actioned_date).'
      tags:
      - Amendment Notifications
      parameters:
      - name: lease_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: amendment_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: notification_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAmendmentNotificationStatusDto'
      responses:
        '200':
          description: Notification updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmendmentNotificationResponse'
        '401':
          description: Unauthorized
        '404':
          description: Notification not found
    delete:
      operationId: deleteAmendmentNotification
      summary: Delete a notification
      description: Permanently deletes an amendment notification.
      tags:
      - Amendment Notifications
      parameters:
      - name: lease_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: amendment_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: notification_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Notification deleted
        '401':
          description: Unauthorized
        '404':
          description: Notification not found
components:
  schemas:
    AmendmentNotificationResponse:
      type: object
      required:
      - id
      - amendment_id
      - lease_id
      - notification_type
      - status
      - title
      - recipient_type
      - recipient_id
      - created_at
      - updated_at
      properties:
        id:
          type: string
          format: uuid
        amendment_id:
          type: string
          format: uuid
        lease_id:
          type: string
          format: uuid
        notification_type:
          type: string
          description: Type of notification. VALIDATION_PENDING and RENT_MODIFICATION_NOTICE are reserved for future use.
          enum:
          - SIGNATURE_REQUIRED
          - AMENDMENT_ACTIVATED
          - AMENDMENT_EXPIRING
          - AMENDMENT_REJECTED
          - VALIDATION_PENDING
          - RENT_MODIFICATION_NOTICE
        status:
          type: string
          enum:
          - DRAFT
          - SENT
          - READ
          - ACTIONED
          - EXPIRED
        title:
          type: string
        content:
          type:
          - object
          - 'null'
        recipient_type:
          type: string
          enum:
          - OWNER
          - LESSEE
          - VALIDATOR
          - CREATOR
        recipient_id:
          type: string
          format: uuid
        sent_date:
          type:
          - string
          - 'null'
          format: date-time
        read_date:
          type:
          - string
          - 'null'
          format: date-time
        actioned_date:
          type:
          - string
          - 'null'
          format: date-time
        expires_at:
          type:
          - string
          - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    UpdateAmendmentNotificationStatusDto:
      type: object
      required:
      - status
      properties:
        status:
          type: string
          enum:
          - SENT
          - READ
          - ACTIONED
          - EXPIRED
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key with fp_* prefix, passed as Bearer token
    WorkerApiKey:
      type: apiKey
      in: header
      name: X-API-Key
    WorkerBearer:
      type: http
      scheme: bearer
      bearerFormat: Worker