---
title: "TRIPS Web - Client API"
description: "This guide provides a detailed overview of the TRIPS Client API, along with step-by-step instructions for generating and using a personal API token. The API enables approved external systems, such as partner platforms or reporting tools to securely access and manage client, booking, and booking-related financial information within Trips. Creating a personal token allows these systems to connect and retrieve up-to-date data efficiently, reducing the need for manual processes. For further information or any questions regarding the Trips Client API and its capabilities, please contact TRIPS Customer Care through the Help Centre."
canonical_url: "https://support.caremaster.com.au/articles/trips-web-client-api-6yYZUDXfS7"
md_url: "https://support.caremaster.com.au/articles/trips-web-client-api-6yYZUDXfS7.md"
---
# TRIPS Web - Client API

This guide provides a detailed overview of the TRIPS Client API, along with step-by-step instructions for generating and using a personal API token. The API enables approved external systems, such as partner platforms or reporting tools to securely access and manage client, booking, and booking-related financial information within Trips. Creating a personal token allows these systems to connect and retrieve up-to-date data efficiently, reducing the need for manual processes. For further information or any questions regarding the Trips Client API and its capabilities, please contact TRIPS Customer Care through the [Help Centre](https://support.caremaster.com.au/en-us?region=AU).

## Account Settings – API Section

A new API Settings section is available in your Account Settings page, with two key subsections:

1. **Manage Your Personal Access Tokens**

* Personal access tokens act like passwords and are stored encrypted. They cannot be retrieved once generated, so users must copy and securely store tokens immediately.
* When generating a token, you can:

  * Name the token for easy identification.
  * Specify the token’s scope (permissions). Current scopes include:

    * View clients – read client information.
    * Manage clients – create and update client information.
    * View bookings – read booking information.
* Once generated, the confirmation dialog will warn you to copy the token, and the confirm button is disabled until copied.
* Tokens can then be used to access the API according to their defined scope.
* **PLEASE NOTE:** Only users with the ***Admin*** role will have visibility of the ***API Settings*** tile within Account Settings. As a result, only Admin users can create API tokens and access the API Documentation page.

2. **View API Documentation**

* The Trips API documentation is interactive and automatically generated.
* Using your personal access token, you can:

  * Test API requests.
  * Examine responses in real time.
  * Apply filters and parameters to refine queries.

- The documentation also explains:

  * Query parameters (type and purpose).
  * Response structure (fields and data types).

## Using the API

* The API is a REST API authenticated via personal access tokens.
* For testing outside the API Documentation, tools like Postman can be used:

  * Trips API specification can be exported as an OpenAPI definition file and imported into Postman.
  * Remember to add your access token to enable you to send requests.

- **PLEASE NOTE:** Only users with the ***Admin*** role will have visibility of the ***API Settings*** tile within Account Settings. As a result, only Admin users can create API tokens and access the API Documentation page.

  

## **How To Create a Client and Use a Client API Token  in the TRIPS Web application:**

**Step 1 -** Click on your name > Select ***Account Settings*** .



![](https://support.caremaster.com.au/api/attachments.redirect?id=41950751-51e5-4281-a7c4-0407fb794180 " =409x298")



**Step 2 -** Select ***Manage your personal access tokens*** within the API Settings tile. 

![](https://support.caremaster.com.au/api/attachments.redirect?id=86ce0142-747a-4017-819a-c58db62421b5 " =534x455")



**Step 3 -** Select the ***Add personal access token*** button.



![](https://support.caremaster.com.au/api/attachments.redirect?id=bfcd74a8-2510-4b68-9ac2-eb76fa3b3895 " =1104x415")





**Step 4 -** Select the abilities you require within the API by checking the relevant options: ***View Clients****,* ***Manage Clients****,* and ***View Bookings***. Once you have made your selections, click **Confirm** to proceed.



![](https://support.caremaster.com.au/api/attachments.redirect?id=0d711c86-01a9-48c8-9681-575705999381 " =550x350")



**Step 5 -** The ***Create Personal Access Token*** window will open. Click ***Copy*** next to the encrypted token to copy it. Once copied, the ***Confirm*** button will become active. Once you click it, the window will close, and your newly created token will be visible in the ***API Key*** list.

**PLEASE NOTE:** Ensure you store your API token securely, as it provides access to sensitive client and booking information and can not be recovered. 

![](https://support.caremaster.com.au/api/attachments.redirect?id=9e1eeaf3-df27-4a0c-b10b-0d01bff8edab " =1237x388")

![](https://support.caremaster.com.au/api/attachments.redirect?id=add46604-f2c2-4865-b51d-8cb9db65d18a " =1237x388")



**Step 6** – Click the **three-dot menu** next to your token to display the available actions: ***Edit*** and ***Revoke***.

* ***Edit*** allows you to add or remove abilities for the token.
* ***Revoke*** deletes the access token, rendering it unauthorized for use with the API.

**PLEASE NOTE:** After revoking a token, a user can still access the ***API Documentation*** page, but will not have authorization to perform any actions. A new token can be created by selecting ***Add Personal Access Token***, which is useful if the original token has been misplaced.



![](https://support.caremaster.com.au/api/attachments.redirect?id=f840d0d2-4437-417d-8023-ff2b3fb016a7 " =1070x292")



**Step 7** – Your token has now been created. You can return to ***Account Settings > API Settings***, then select ***API Documentation*** to access the API page and start using your token.

![](https://support.caremaster.com.au/api/attachments.redirect?id=199ee691-cb35-4117-8b15-89702bcafbe0 " =534x455")



**PLEASE NOTE:** For further information or any questions regarding the Trips Client API and its capabilities, please contact TRIPS Customer Care through the [Help Centre](https://support.caremaster.com.au/en-us?region=AU).