{
  "opencollection": "1.0.0",
  "info": {
    "name": "nCino Mortgage Region Branches API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Region Branches",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a region's branches",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ncinomortgage.com/regions/:region_id/branches",
            "headers": [
              {
                "name": "X-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "region_id",
                "value": "",
                "type": "path",
                "description": "Region ID."
              },
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "State by which to filter branches."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page to retrieve."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of records returned in each page."
              },
              {
                "name": "created_after",
                "value": "",
                "type": "query",
                "description": "The date which a resource must be created after to be returned."
              },
              {
                "name": "created_before",
                "value": "",
                "type": "query",
                "description": "The date which a resource must be created before to be returned."
              },
              {
                "name": "updated_after",
                "value": "",
                "type": "query",
                "description": "The date which a resource must be updated after to be returned."
              },
              {
                "name": "updated_before",
                "value": "",
                "type": "query",
                "description": "The date which a resource must be updated before to be returned."
              }
            ]
          },
          "docs": "This endpoint will retrieve a list of <<glossary:branch>>es under a given <<glossary:region>>."
        },
        {
          "info": {
            "name": "Create a new branch for given region",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ncinomortgage.com/regions/:region_id/branches",
            "headers": [
              {
                "name": "X-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "region_id",
                "value": "",
                "type": "path",
                "description": "Region ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint will create a <<glossary:branch>> in the platform under a given <<glossary:region>>."
        },
        {
          "info": {
            "name": "Retrieve a specific branch",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ncinomortgage.com/regions/:region_id/branches/:branch_id",
            "headers": [
              {
                "name": "X-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "branch_id",
                "value": "",
                "type": "path",
                "description": "Branch ID."
              },
              {
                "name": "region_id",
                "value": "",
                "type": "path",
                "description": "Region ID."
              }
            ]
          },
          "docs": "This endpoint will retrieve a specific <<glossary:branch>> under a given <<glossary:region>>."
        },
        {
          "info": {
            "name": "Update a branch's information",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.ncinomortgage.com/regions/:region_id/branches/:branch_id",
            "headers": [
              {
                "name": "X-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "branch_id",
                "value": "",
                "type": "path",
                "description": "Branch ID."
              },
              {
                "name": "region_id",
                "value": "",
                "type": "path",
                "description": "Region ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint will update a <<glossary:branch>> under a given <<glossary:region>>."
        },
        {
          "info": {
            "name": "Delete a branch",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.ncinomortgage.com/regions/:region_id/branches/:branch_id",
            "headers": [
              {
                "name": "X-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "branch_id",
                "value": "",
                "type": "path",
                "description": "glossary:Branch ID."
              },
              {
                "name": "region_id",
                "value": "",
                "type": "path",
                "description": "glossary:Region ID."
              }
            ]
          },
          "docs": "This endpoint will update a <<glossary:branch>> under a given <<glossary:region>>.\n\n> 🙇 Heads up!\n**The branch is not deleted immediately, but deleted in an <<glossary:asynchronous job>>.**"
        }
      ]
    }
  ],
  "bundled": true
}