{
  "opencollection": "1.0.0",
  "info": {
    "name": "Rentberry Contracts API",
    "version": "4"
  },
  "items": [
    {
      "info": {
        "name": "Contracts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List signed contracts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v:version/contract",
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Returns a list of signed contracts for the authenticated user."
        },
        {
          "info": {
            "name": "Create a new contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/contract",
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Available since API version 1. Creates a new contract based on a template and associates it with a rental."
        },
        {
          "info": {
            "name": "Publish contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/contract/publish/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Contract ID"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Initiates the contract publishing process and returns signing URL if embedded signing is required."
        },
        {
          "info": {
            "name": "Invite to sign contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/contract/invite/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Rental ID"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Sends an invitation email to the homeowner to sign a contract."
        },
        {
          "info": {
            "name": "List contracts for a rental",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v:version/contract/rental/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Rental ID"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Returns a list of contracts associated with a specific rental."
        },
        {
          "info": {
            "name": "Get contract signing URL",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v:version/contract/sign/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Contract ID"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Returns a URL for signing a contract using embedded signing."
        },
        {
          "info": {
            "name": "Sign contract with token",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v:version/contract/sign/token/:token",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "Contract sign token"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Returns a URL for signing a contract using a sign token."
        },
        {
          "info": {
            "name": "Get contract signatures",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v:version/contract/:id/signatures",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Contract ID"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Returns information about signatures for a specific contract."
        },
        {
          "info": {
            "name": "Delete contract",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v:version/contract/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Contract ID"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Deletes a contract. Only the homeowner of the associated listing can delete the contract."
        },
        {
          "info": {
            "name": "Download contract",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v:version/contract/download/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Contract ID"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Downloads the signed contract as a PDF file."
        },
        {
          "info": {
            "name": "Handle contract signing callback",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/contract/callback",
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Available since API version 1. Processes callbacks from Dropbox Sign when contracts are signed or declined."
        }
      ]
    }
  ],
  "bundled": true
}