Creating an API Key in HaloPSA
- Log into Halo PSA and navigate to Advanced. From the dashboard, navigate to Integrations.
2. Next Click on HaloPSA API
3. HaloPSA to vCIOToolbox API mappings
- Resource Server URL maps to HaloPSA API URL
- Authorization Server maps to HaloPSA Auth URL
4. In the Applications section, click on View Applications.
5. Create a new application and name it vCIOToolbox.
6. Build the Application
- Give the Application a Name (suggested: vCIOToolbox)
- Choose Client ID and Secret
- This will generate the Client ID and the Client Secret (Record these values for use in vCIOToolbox)
- Choose Agent and then choose the Agent account for use with the API
7. Edit the permissions in the Permissions tab
Enable: All Teams
8. The following permissions must be enabled to use the API.
| API Permissions | Agent Permissions |
| Teams: All | Yes |
| Read:tickets | Yes |
| Edit:tickets | Yes |
| Read:customers | Yes |
| Edit:customers | Yes |
| Read:crm | Yes |
| Edit:crm | Yes |
| Read:contracts | Yes |
| Edit:contracts | Yes |
| Read:sales | Yes |
| Edit: sales | Yes |
| Read:invoices | Yes |
| Edit:invoices | Yes |
| Read:assets | Yes |
| Edit:assets | Yes |
8. Agent permissions need to be equivalent to the API, and as noted above, the teams must enable: All Teams
| Agent Permissions Required | |
| Is a HaloPSA Admin | Yes |
| Feature Access | Tickets | Read and Modify |
| Customer Access Level | Read and Modify |
| CRM | Read and Modify |
| Asset Access | Read and Modify |
| Products | Read and Modify |
| Invoices | Read Only |
| Reports | Read Only |
| Ticket Permissions | |
| Can add new tickets | Yes |
| Can edit closed Tickets | Yes |
| Can view unassigned tickets | Yes |
| Can change a tickets type | Yes |
| Can reassign tickets | Yes |
| Can edit advanced ticket details | Yes |
| Editing of Actions | Can edit all actions |
| Can delete tickets | No |
| Can assign to agents in Teams the agent is not a member of | Yes |
| Can export tickets | Yes |
| Asset Type Restrictions | |
| Allow Use of all asset types | Yes |
| Ticket Type Restrictions | |
| Allow use of all ticket types | Yes |
| Asset Field Restrictions | |
| Allow the use of all Asset fields | Yes |
9. Agent Department and Teams: Also ensure that the agent has access to all Teams in Halo.
