{
  "opencollection": "1.0.0",
  "info": {
    "name": "nCino Mortgage Loan Officer Prospects API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Loan Officer Prospects",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve all of a loan officer's prospects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ncinomortgage.com/users/loan_officers/:loan_officer_id/prospects",
            "headers": [
              {
                "name": "X-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "loan_officer_id",
                "value": "",
                "type": "path",
                "description": "Loan officer ID."
              },
              {
                "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 all of a <<glossary:loan officer>>'s prospects."
        },
        {
          "info": {
            "name": "🚧 Create a loan officer prospect (BETA)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ncinomortgage.com/users/loan_officers/:loan_officer_id/prospects",
            "headers": [
              {
                "name": "X-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "loan_officer_id",
                "value": "",
                "type": "path",
                "description": "Loan officer ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "> 🚧 Under construction\n> **This endpoint is in beta.** Functionality may change without notice, support is limited, and use in production is not recommended. Your feedback is appreciated.\n\nThis endpoint will create a prospect for a <<glossary:loan officer>>. At least one of email or cell_phone must be supplied."
        },
        {
          "info": {
            "name": "Retrieve a loan officer prospect",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ncinomortgage.com/users/loan_officers/:loan_officer_id/prospects/:prospect_id",
            "headers": [
              {
                "name": "X-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "loan_officer_id",
                "value": "",
                "type": "path",
                "description": "Loan officer ID."
              },
              {
                "name": "prospect_id",
                "value": "",
                "type": "path",
                "description": "Prospect ID."
              }
            ]
          },
          "docs": "This endpoint will retrieve a <<glossary:loan officer>> prospect."
        }
      ]
    }
  ],
  "bundled": true
}