Skip to content
English
More support
Go to app.holistiplan.com
  • There are no suggestions because the search field is empty.

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. To request API access, contact support@holistiplan.com.

 

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
    Screenshot 2025-02-25 at 2.20.15 PM

  4. Click Create New

  5. Complete the following:

    • Name your application

    • Assign it to a user
      Screenshot 2025-02-25 at 2.29.32 PM

  6. Copy and securely store your:

    • Client ID

    • Client Secret


      Screenshot 2025-02-25 at 2.29.57 PM

Don’t see API Keys?

If the API Keys section is not visible, contact support@holistiplan.com and request that OAuth Self Serve be enabled for your firm.

2. Authentication

Holistiplan’s API uses OAuth 2.0 Client Credentials authentication.

Token Endpoint

POST https://app.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 <token>

  • The scope must be read write
    Using only read or write will cause errors on API calls.

3. Base URL and Making Requests

Holistiplan currently supports two API versions.

Version Base URL
v1 https://app.holistiplan.com/api/public/v1/
v2 https://app.holistiplan.com/api/public/v2/

Example Request

Retrieve a list of households:

GET https://app.holistiplan.com/api/public/v1/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://...?limit=10&offset=10",
  "previous": null,
  "results": [...]
}

Use the next and previous URLs in the response to navigate between pages.

5. Rate Limits

Rate limits may apply to API usage.

If you are planning a large integration or high-volume data access, contact support@holistiplan.com for the current limits and best practices.

6. Interactive API Documentation

The Holistiplan API includes interactive documentation for testing and exploring endpoints.

Documentation

https://app.holistiplan.com/api/public/docs/

Features

  • Switch between v1 and v2 using the version dropdown

  • View endpoint parameters, schemas, and examples

  • Test API calls using Try it out

OpenAPI Schema

You can also access the raw OpenAPI schema:

https://app.holistiplan.com/api/public/schema/openapi/v1/
https://app.holistiplan.com/api/public/schema/openapi/v2/

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 so our team can investigate quickly.

Helpful Links

API Documentation
https://app.holistiplan.com/api/public/docs/

REST API Basics (AWS)
https://aws.amazon.com/what-is/restful-api/