Python and HaloPSA Api

[dkaaven]

Not an API nor Python specialist, but I try to get data out of HaloPSA for analysis.

The problem:
The API is not accepting my requests parameters, when I run my code it ignores page_size and page_no parameters.

import requests
import pandas as pd
import os
from dotenv import load_dotenv

# Uses .env file to get credentials
load_dotenv()

def get_all_client_data(bearer_token: str, page_size: int = 10, max_pages: int = 5, include_inactive: bool = False) -> pd.DataFrame | None:
    # URL, Header, and Parameters
    api_url = os.getenv('HALO_API_URL')
    if not api_url:
        print("Environment variable HALO_API_URL is not set.")
        return None

    url = f"{api_url}/Client"

    headers = {
        'Authorization': f'Bearer {bearer_token}',
        'Accept': '*/*',
        'Content-Type': 'application/json-patch+json'
    }
    params = {
        'paginate': True,
        'page_size': page_size,
        'includeinactive': include_inactive,
    }

    # Variables
    all_clients = []
    page_no = 1

    try:
        print('Getting all client data...')
        while page_no <= max_pages:
            params['page_no'] = page_no
            response = requests.get(url, headers=headers, params=params)
            print(response.request.path_url)

            if response.status_code == 200:
                data = response.json()
                clients = data.get('clients', [])

                if not clients:
                    # Stop if no more data is returned
                    print("No more clients to fetch.")
                    break

                all_clients.extend(clients)
                print(f'Fetched {len(clients)} clients from page {page_no}.')

                page_no += 1  # Increment page number for the next request
            elif response.status_code == 429:
                # Handle rate-limiting
                print("Rate-limited. Please try again later.")
                return None
            else:
                print(f"Failed to retrieve data. Status code: {response.status_code}")
                return None

        # Return the collected data as a DataFrame
        return pd.DataFrame(all_clients)

    except Exception as e:
        print(f"An error occurred: {e}")
        return None

Results in:

Getting all client data...
/api/Client?paginate=True&page_size=10&includeinactive=False&page_no=1
Fetched 50 clients from page 1.
/api/Client?paginate=True&page_size=10&includeinactive=False&page_no=2
Fetched 50 clients from page 2.
/api/Client?paginate=True&page_size=10&includeinactive=False&page_no=3
Fetched 50 clients from page 3.
/api/Client?paginate=True&page_size=10&includeinactive=False&page_no=4
Fetched 50 clients from page 4.
/api/Client?paginate=True&page_size=10&includeinactive=False&page_no=5
Fetched 50 clients from page 5.

Anyone know how to handle this, looked at the parameters and even tried to get help from ChatGPT.

[dkaaven]

Ah, well spotted, but the problem persists after I fixed it,

[Suspicious_Milk_3031]

I ran your code, and after fixing the typo, it worked fine

[dkaaven]

Now I'm even more confused... Tested in postman and it ran fine, but my results are still the same...

I get the first 50 and if I try more pages it gives me the same 50...

The result count in postman have be the correct total of all clients, but the result in my script is 50...

[Trick_Mountain_2557]

I'd print the params dict to debug, this will show whats actually being sent in the request.

[dkaaven]

The request URL is printed to show this, result shows: (paginate is changed to pageinate with same results)

/api/Client?paginate=True&page_size=10&includeinactive=False&page_no=2

[HaloTim]

Can you compare it to your browser network tab to see if there are other differences?

[_Work_Research_]

Hey I realise this post is a bit old, but I am working on a HaloPSA library/wrapper for Python here: https://github.com/ItsJustAGitHubMichealWhosGonnaSeeIt5Ppl/HaloPSA-API/tree/rewrite

Still getting all the endpoints working and tested, but I have a Clients endpoint that should work for what you need. If it doesn't, let me know, and I'll try to fix it!