--- title: Getting Started with the Holistiplan API description: This guide will walk you through the steps needed to make your first API call to the Holistiplan API and go over how these calls can be made in Postman --- [Skip to content](https://help.holistiplan.com/getting-started-with-the-holistiplan-api#main-content) English Show submenu for translations [More support](https://help.holistiplan.com/kb-tickets/new?hsLang=en) [![Holistiplan Logo (800x200 px).webp\]](https://help.holistiplan.com/hs-fs/hubfs/Holistiplan%20Logo%20(800x200%20px).webp?width=160&height=40&name=Holistiplan%20Logo%20(800x200%20px).webp)](https://www.holistiplan.com/) Open main navigation Close main navigation - English Show submenu for translations - [More support](https://help.holistiplan.com/kb-tickets/new) Holistiplan Knowledge Base - There are no suggestions because the search field is empty. 1. [Help Center](https://help.holistiplan.com/?hsLang=en) 2. [Integrations](https://help.holistiplan.com/integrations?hsLang=en) 3. [API](https://help.holistiplan.com/integrations?hsLang=en#api) # Getting Started with the Holistiplan API ## The Holistiplan Public API allows firms and integration partners to programmatically access and interact with Holistiplan data. Access to the Public API is evaluated on a case-by-case basis. ### [Click here to request access](https://share.hsforms.com/1VB2lAiH6Q3io6iQmgp5jaQ57lb1?__hstc=19606951.9586c43ea4a70088c7087c44f8be2053.1788380430366.1789656440302.1789662559988.32&__hssc=19606951.5.1789662559988&__hsfp=b266fc28dcfa145590a27d5ec7937477) ### Once access is approved ### 1. Create API Credentials To begin, create API credentials in your Holistiplan account. 1. Navigate to **Settings** 2. Select **Security Settings** 3. Open **API Keys** 4. Click **Create New** 5. Complete the following: - Name your application - Assign it to a user 6. Copy and securely store your: - **Client ID** - **Client Secret** ### 2. Authentication Holistiplan's API uses **OAuth 2.0 Client Credentials** authentication. **Token Endpoint** `POST https://api.holistiplan.com/o/token/` #### Request Fields | Field | Value | | --- | --- | | `grant_type` | `client_credentials` | | `client_id` | Your Client ID | | `client_secret` | Your Client Secret | | `scope` | `read write` | #### Important Notes - Tokens expire after 10 hours. - Include the token in all requests using the header:`Authorization: Bearer ` - The scope must be `read write`. Using only `read` or `write` will cause errors on API calls. ### 3. Base URL and Making Requests Holistiplan's Public API uses **API v2**. **Base URL** `https://api.holistiplan.com/v2/` #### Example Request Retrieve a list of households: `GET https://api.holistiplan.com/v2/households/` ### 4. Pagination List endpoints use limit/offset pagination. #### Query Parameters | Parameter | Default | Max | Description | | --- | --- | --- | --- | | `limit` | 10 | 100 | Number of results returned | | `offset` | 0 | — | Number of results to skip | #### Example Response ``` { "count": 150, "next": "https://api.holistiplan.com/v2/households/?limit=10&offset=10", "previous": null, "results": [...] } ``` Use the `next` and `previous` URLs returned in the response to navigate between pages. ### 5. Rate Limits The Public API is limited to **1,000 requests per hour per client in production**. If you are planning a large integration or high-volume data access, contact [support@holistiplan.com](mailto:support@holistiplan.com) for current limits and best practices. ### 6. Interactive API Documentation The Holistiplan API includes interactive documentation for testing and exploring v2 endpoints. **API Documentation** `https://app.holistiplan.com/api/public/docs/` #### Features - View v2 endpoints - View endpoint parameters, schemas, and examples - Test API calls using **Try it out** ### Authenticating in the Docs To make authenticated requests inside the documentation: 1. Configure OAuth 2.0 Client Credentials 2. Enter your: - Client ID - Client Secret - Scope: `read write` 3. Click **Get Token** Once authorized, you can run requests directly from the documentation interface. ### Troubleshooting Errors When contacting support about an API issue, please include: - A screenshot of the error - The full request URL - Any request body or parameters Send this information to [support@holistiplan.com](mailto:support@holistiplan.com) so our team can investigate quickly. - [Getting Started at Holistiplan - 101](https://help.holistiplan.com/getting-started-at-holistiplan-101?hsLang=en#main-content) - [How to Contact Support](https://help.holistiplan.com/getting-started-at-holistiplan-101?hsLang=en#how-to-contact-support) - [Ready to Get Started?](https://help.holistiplan.com/getting-started-at-holistiplan-101?hsLang=en#ready-to-get-started) - [Getting Started with Your Households](https://help.holistiplan.com/getting-started-at-holistiplan-101?hsLang=en#getting-started-with-your-households) - [Tax Report](https://help.holistiplan.com/getting-started-at-holistiplan-101?hsLang=en#tax-report) - [Scenario Analysis](https://help.holistiplan.com/getting-started-at-holistiplan-101?hsLang=en#scenario-analysis) - [Master Your Dashboard](https://help.holistiplan.com/getting-started-at-holistiplan-101?hsLang=en#master-your-dashboard) - [Tips for New Users](https://help.holistiplan.com/getting-started-at-holistiplan-101?hsLang=en#tips-for-new-users) - [Deeper Dive at Holistiplan - 201](https://help.holistiplan.com/deeper-dive-at-holistiplan-201?hsLang=en#main-content) - [Mastering the Tax Report: Advanced Insights and Analysis](https://help.holistiplan.com/deeper-dive-at-holistiplan-201?hsLang=en#mastering-the-tax-report-advanced-insights-and-analysis) - [Advanced Planning with Scenario Analysis](https://help.holistiplan.com/deeper-dive-at-holistiplan-201?hsLang=en#advanced-planning-with-scenario-analysis) - [Roth Projection Tool](https://help.holistiplan.com/deeper-dive-at-holistiplan-201?hsLang=en#roth-projection-tool) - [Using the Tax Explainer](https://help.holistiplan.com/deeper-dive-at-holistiplan-201?hsLang=en#using-the-tax-explainer) - [Tax Letter- Adding Value for Your Clients](https://help.holistiplan.com/deeper-dive-at-holistiplan-201?hsLang=en#tax-letter-adding-value-for-your-clients) - [Holistiplan Basics](https://help.holistiplan.com/holistiplan-basics?hsLang=en#main-content) - [Uploading Returns](https://help.holistiplan.com/holistiplan-basics?hsLang=en#uploading-returns) - [Household Information](https://help.holistiplan.com/holistiplan-basics?hsLang=en#household-information) - [Tools & Resources](https://help.holistiplan.com/holistiplan-basics?hsLang=en#tools-resources) - [Firm Admins](https://help.holistiplan.com/holistiplan-basics?hsLang=en#firm-admins) - [Holistiplan Academy - Upload Breakdown](https://help.holistiplan.com/holistiplan-academy-upload-breakdown?hsLang=en#main-content) - [Tax Report](https://help.holistiplan.com/holistiplan-academy-upload-breakdown?hsLang=en#tax-report) - [Scenario Analysis](https://help.holistiplan.com/holistiplan-academy-upload-breakdown?hsLang=en#scenario-analysis) - [Billing and Subscriptions](https://help.holistiplan.com/billing-and-subscriptions?hsLang=en) - [User Admin](https://help.holistiplan.com/user-admin?hsLang=en) - [Tax Reports](https://help.holistiplan.com/tax-reports?hsLang=en#main-content) - [Tax Report FAQ](https://help.holistiplan.com/tax-reports?hsLang=en#tax-report-faq) - [Scenario Analysis](https://help.holistiplan.com/scenario-analysis?hsLang=en#main-content) - [General Administration and Editing](https://help.holistiplan.com/scenario-analysis?hsLang=en#general-administration-and-editing) - [Business Income](https://help.holistiplan.com/scenario-analysis?hsLang=en#business-income) - [Charitable Giving Strategies](https://help.holistiplan.com/scenario-analysis?hsLang=en#charitable-giving-strategies) - [Credits and Deductions](https://help.holistiplan.com/scenario-analysis?hsLang=en#credits-and-deductions) - [Equity Compensation](https://help.holistiplan.com/scenario-analysis?hsLang=en#equity-compensation) - [Filing Status](https://help.holistiplan.com/scenario-analysis?hsLang=en#filing-status) - [Range Calc/Solve for Max](https://help.holistiplan.com/scenario-analysis?hsLang=en#range-calc-solve-for-max) - [Retirement Plan Contributions and Distributions](https://help.holistiplan.com/scenario-analysis?hsLang=en#retirement-plan-contributions-and-distributions) - [Roth Conversions](https://help.holistiplan.com/scenario-analysis?hsLang=en#roth-conversions) - [State Taxes](https://help.holistiplan.com/scenario-analysis?hsLang=en#state-taxes) - [Strategy Illustrations](https://help.holistiplan.com/scenario-analysis?hsLang=en#strategy-illustrations) - [Wages](https://help.holistiplan.com/scenario-analysis?hsLang=en#wages) - [Scenario Analysis FAQ](https://help.holistiplan.com/scenario-analysis?hsLang=en#scenario-analysis-faq) - [Supplemental Income](https://help.holistiplan.com/scenario-analysis?hsLang=en#supplemental-income) - [Roth Projection Tool](https://help.holistiplan.com/roth-projection-tool?hsLang=en) - [Tax Letters](https://help.holistiplan.com/tax-letters?hsLang=en) - [Explainer Reports](https://help.holistiplan.com/explainer-reports?hsLang=en) - [P&C Insurance Planning](https://help.holistiplan.com/pc-insurance-planning?hsLang=en#main-content) - [Basics](https://help.holistiplan.com/pc-insurance-planning?hsLang=en#basics) - [Getting Started](https://help.holistiplan.com/pc-insurance-planning?hsLang=en#getting-started) - [Features/Additional Information](https://help.holistiplan.com/pc-insurance-planning?hsLang=en#features-additional-information) - [Integrations](https://help.holistiplan.com/integrations?hsLang=en#main-content) - [Single Sign-On](https://help.holistiplan.com/integrations?hsLang=en#single-sign-on) - [API](https://help.holistiplan.com/integrations?hsLang=en#api) - [CRM Integrations](https://help.holistiplan.com/integrations?hsLang=en#crm-integrations) - [Integrations](https://help.holistiplan.com/integrations?hsLang=en#integrations) - [Security](https://help.holistiplan.com/security?hsLang=en) - [Tax Transcripts](https://help.holistiplan.com/tax-transcripts?hsLang=en) Copyright © 2025, Holistiplan LLC