{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"97f31d4f-0f82-4439-9036-d73034ac8b51","name":"dbaPlatform API 2025","description":"## 1.Introduction 🚀\n\nWelcome to **dbaPlatform API Version 2025.1** — your gateway to building powerful, scalable integrations with the tools and data that drive your local business.\n\nThis RESTful API gives developers and integration partners full programmatic access to the core features of dbaPlatform, including managing **agency accounts**, **business locations**, **client groups**, **content** (like posts and photos), and **reviews** — all in one place.\n\nWhether you're syncing systems, automating workflows, or creating custom dashboards, this API is built to help technical teams move faster, reduce manual work, and unlock serious efficiencies.\n\nUse this documentation to:\n\n- Understand how authentication works\n    \n- Learn what IDs are needed\n    \n- Discover available endpoints\n    \n- Start testing and building right away\n    \n\n### 🆘 **Need Help?**\n\nLog in to your dbaPlatform account, head over to the [Support Hub](https://agency.commandpad.io/v2/#/app/loginV2), and submit a ticket — our team is ready to help!\n\n---\n\n## 2.Requirements to Use the API ✅\n\nBefore you dive into the dbaPlatform API, make sure you've checked off the essentials below.\n\n### 🔐 2.1. dbaPlatform Account\n\nYou’ll need a valid user account to authenticate and grab your access token.\n\n### 💼 2.2. Paid Subscription Plan\n\nAPI access is reserved for customers on a **paid subscription plan**. If you're not sure whether your account qualifies, reach out to your customer success manager or submit a ticket via the **Support Hub**.\n\n### 🔑 2.3. Login Credentials\n\nYour email and password will be used in the login request.\n\n``` bash\nPOST /api/account/login\n\n ```\n\n``` json\n{\n  \"userName\": \"your@email.com\",\n  \"password\": \"your_password\"\n}\n\n ```\n\nIf successful, you'll receive a token like this:\n\n**✅ Example Response**\n\n``` json\n{\n  \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}\n\n ```\n\n### 2.4. Required IDs to Access Endpoints 🆔\n\nMany endpoints rely on specific IDs that link your user to locations, agencies, and clients. Here’s how to get them:\n\n#### 🏢 2.4.1. AgencyId\n\nThe `AgencyId` is required for nearly all API requests — it’s one of the key identifiers you’ll use to access and manage data across your account.\n\nNow that you’ve authenticated and retrieved your access token (see \"2.3 Login Credentials\" above), you can make a request to the following endpoint to retrieve your `AgencyId`:\n\n``` bash\nGET /api/location/GetAgencyId\n\n ```\n\nInclude your Bearer token in the `Authorization` header.\n\n**✅ Example Response**\n\n``` json\n{\n  \"AgencyID\": 99999,\n  \"AgencyName\": \"Company name registered with that account\"\n}\n\n ```\n\n💡 Once you have your `AgencyId`, you can use it to query locations, groups, users, and more. For more information and use cases, check the [Agency ](https://documenter.getpostman.com/view/28472993/2sB2cbZe4L#ef9b0737-f785-46a3-81d5-aeb221397592) folder.\n\n#### 📍 2.4.2. LocationId & GroupId\n\nOnce you have your `AgencyId`, call this to fetch associated locations:\n\n``` bash\nGET /api/agency/locations\n\n ```\n\nThe response will include both your `LocationId` and `GroupId`.\n\n**✅ Example Response**\n\n``` json\n{\n  \"LocationId\": \"12345\",\n  \"GroupId\": \"abcde-67890\"\n}\n\n ```\n\n#### 👤 2.4.3. UserId & CompanyId\n\nTo grab your your `UserId` and `CompanyId`, fetch them here:\n\n``` bash\nGET /api/users/active\n\n ```\n\nYou'll see something like:\n\n**✅ Example Response**\n\n``` json\n{\n  \"userId\": \"user_001\",\n  \"companyId\": \"company_789\"\n}\n\n ```\n\n### 🧠 Pro Tip\n\nMake sure you're authenticated. For all protected endpoints, your request should include the following header:\n\n``` bash\nAuthorization: Bearer {{authToken}}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"28472993","team":5827481,"collectionId":"97f31d4f-0f82-4439-9036-d73034ac8b51","publishedId":"2sB2cbZe4L","public":true,"publicUrl":"https://documenter-api.postman.tech/view/28472993/2sB2cbZe4L","privateUrl":"https://go.postman.co/documentation/28472993-97f31d4f-0f82-4439-9036-d73034ac8b51","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"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-04-15T20:18:07.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"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/d27263c44dff3e7f1f82e4f5aad58bf6d315a0b744d5047a183ecc0f442d22b6","favicon":""},"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://documenter.gw.postman.com/view/metadata/2sB2cbZe4L"}