{
  "opencollection": "1.0.0",
  "info": {
    "name": "Rentberry Applications API",
    "version": "4"
  },
  "items": [
    {
      "info": {
        "name": "Applications",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Upload a new applicant attachment.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/applicant/proof-income",
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Available since API version 1. Requires ROLE_USER."
        },
        {
          "info": {
            "name": "Update an existing applicant attachment.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/applicant/proof-income/:id",
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Available since API version 1. Requires ROLE_USER and ownership of the attachment."
        },
        {
          "info": {
            "name": "Delete an applicant attachment.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v:version/applicant/proof-income/:id",
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Requires ROLE_USER and ownership of the attachment."
        },
        {
          "info": {
            "name": "Download an applicant attachment file.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v:version/applicant/proof-income/download/:id",
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Requires ROLE_USER and ownership of the attachment."
        },
        {
          "info": {
            "name": "Retrieve the last active applicant for the authenticated user.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v:version/applicant",
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Requires ROLE_USER."
        },
        {
          "info": {
            "name": "Create a new applicant record.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/applicant",
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Available since API version 1. Requires ROLE_USER."
        },
        {
          "info": {
            "name": "Edit an existing applicant.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/applicant/:id",
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Available since API version 1. Requires ROLE_USER and ownership of the applicant."
        },
        {
          "info": {
            "name": "Submit the applicant for review.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v:version/applicant/:id",
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Requires ROLE_USER and ownership of the applicant."
        },
        {
          "info": {
            "name": "Retrieve list of applicants.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v:version/applicant/list",
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Requires ROLE_USER."
        },
        {
          "info": {
            "name": "Get application details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v:version/apartment/apply/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Application ID"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Returns detailed information about a specific application, including pricing status, notifications, and competitive data."
        },
        {
          "info": {
            "name": "Edit application",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/apartment/apply/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Application ID"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Available since API version 1. Modifies an existing application, updating price, deposit, and other details."
        },
        {
          "info": {
            "name": "Decline or withdraw application",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v:version/apartment/apply/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Application ID"
              },
              {
                "name": "declinedReason",
                "value": "",
                "type": "query",
                "description": "Reason for declining (only used when listing owner declines)"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Declines an application (if called by listing owner) or withdraws it (if called by applicant)."
        },
        {
          "info": {
            "name": "Get applications for a specific listing",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v:version/apartment/apply/apartment/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Listing ID"
              },
              {
                "name": "active",
                "value": "",
                "type": "query",
                "description": "Filter by active status (true = active applications, false = all applications)"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of items per page"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Returns applications received for a specific listing owned by the authenticated user."
        },
        {
          "info": {
            "name": "Get applications sent by authenticated user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v:version/apartment/apply",
            "params": [
              {
                "name": "deleted",
                "value": "",
                "type": "query",
                "description": "Filter by deleted status (0 = active applications, 1 = deleted applications)"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of items per page"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Returns a list of applications submitted by the authenticated user."
        },
        {
          "info": {
            "name": "Create a new application",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/apartment/apply",
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Available since API version 1. Creates a new application for a listing."
        },
        {
          "info": {
            "name": "Confirm application (DEPRECATED)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/apartment/apply/confirm/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Application ID"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Available since API version 1. DEPRECATED - Used only for mobile apps. Confirms an application by setting necessary confirmation flags."
        },
        {
          "info": {
            "name": "Accept application",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v:version/apartment/apply/accept/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Application ID"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Accepts an application, creating a rental agreement and marking the listing as rented."
        }
      ]
    }
  ],
  "bundled": true
}