{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f10cbc0c-261e-4c90-a765-0bf4811f84eb","name":"CLA Product API - Endpoints","description":"**Audience:** External partners & integrators  \n**Change policy:** Non-breaking changes may occur without notice. Breaking  \nchanges require a minimum 30-day deprecation window and a Sunset header on  \naffected responses.\n\nThe CLA Product API exposes user-facing capabilities for Construction Loan  \nAdministration. This section lists beta endpoints only. Production traffic is  \nallowed but integrations must be prepared for minor, backwards-compatible  \nadjustments.\n\n## Authentication & Authorization\n\nAll requests must include:\n\n| Header | Description |\n| --- | --- |\n| X-BUILT-API-KEY: {{api_key}} | Provisioned in the Built app under Settings → API |\n| Authorization: {{api_secret}} | Provisioned in the Built app under Settings → API |\n\nTokens will expire based on how they were configured in the Built app under  \nSettings → API.\n\n---\n\n# Quickstart: Using the CLA Partner API\n\nWelcome! If this is your first time with the CLA Partner API, this guide will  \nwalk you through the recommended first steps. The API is centered around Deals  \n(loan agreements). Once you can search and retrieve deals, you can branch into  \nrelated resources like checklists, files, draws and inspections.\n\n## Step 1 — Search for Your Deals\n\nStart by listing the deals your organization has access to.\n\n- **Endpoint:** `GET /deal`\n    \n- **Purpose:** Returns list of deals.\n    \n- **Use case:** \"Show me all the loans my organization is working on.\"\n    \n\n## Step 2 — Retrieve Deal Details\n\nOnce you have a deal_uid (dealUid), you can drill into the deal:\n\n- `GET /deal/{deal_uid}` → Core info (status, IDs, product type).\n    \n- `GET /deal/{deal_uid}/details` → Extended metadata (loan type, flags,  \n    balances).\n    \n\nUse this to populate dashboards or validate before proceeding.\n\n## Step 3 — Explore Deal Resources\n\nEvery deal can have related resources:\n\n- **Checklist** → `GET /deal/{deal_uid}/checklist` View compliance items  \n    required for funding.\n    \n- **Files** → `GET /deal/{deal_uid}/files` Fetch contracts, permits, inspection  \n    docs.\n    \n- **Draws** → `GET /deal/{deal_uid}/draws`  \n    See funding requests and disbursements.\n    \n- Inspections → `GET /deal/{deal_uid}/inspections`  \n    Check scheduled or completed site inspections.\n    \n- **Activity** → `GET /deal/{deal_uid}/activity?page=1&per_page=10`  \n    See related activity information for deal.\n    \n\n> 🔑 **Pro tip:**  \n1\\. Always begin with Search for Deals → get a deal_uid → then drill deeper  \ninto the endpoints that matter most to your workflow. This approach  \nensures you understand the deal first before moving into compliance,  \ndocuments, or funding.  \n2\\. Some endpoints require a valid tenant_id to access or filter data  \ncorrectly. Make sure you retrieve and include the tenant_id from deal  \ndetails before calling these endpoints.  \n3\\. Ensure that each lender has a primary administrator assigned. This  \nassociation is required for correct authorization, data retrieval, and  \naccess across the CLA Public API endpoints. \n  \n\n## GLOSSARY\n\n| Term | Definition |\n| --- | --- |\n| Deal | A loan agreement record in the CLA system, identified by a UID. It can also be referenced as agreement. |\n| Draw | A funding request or disbursement made against a deal/Loan agreement |\n| Checklist | A list of compliance or documentation items required for a deal to be processed, approved and transferred. |\n| Files | Documents or attachments linked to a deal (e.g., contracts, permits). |\n| Inspection | A property check tied to a deal, including scheduling, and progress. |\n| Product Type | A category of loan product (e.g., Residential, renovation, line of credit, etc. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"44590548","team":21009,"collectionId":"f10cbc0c-261e-4c90-a765-0bf4811f84eb","publishedId":"2sB3Hevjd9","public":true,"publicUrl":"https://cla-partners.getbuilt.com","privateUrl":"https://go.postman.co/documentation/44590548-f10cbc0c-261e-4c90-a765-0bf4811f84eb","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"CLA Public documentation"},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-08-26T15:09:13.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"CLA Public documentation"},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/01972c9000ed1b6226ea8d37bcc081e3355d258e60a117d4f0ddbc57da26f8cf","favicon":"https://res.cloudinary.com/postman/image/upload/v1714764308/team/u55yajmuyutm15raua1b.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://cla-partners.getbuilt.com/view/metadata/2sB3Hevjd9"}