HaloPSA

App · 25 actions

Read HaloPSA service records and create tickets, customers, sites, users and ticket notes.

Actions

ActionWhat it does
Add ticket noteAdd ticket note.
Create customerCreate customer.
Create siteCreate site.
Create ticketCreate ticket.
Create userCreate user.
Get agentGet agent.
Get assetGet asset.
Get customerGet customer.
Get priorityGet priority.
Get siteGet site.
Get ticketGet ticket.
Get ticket actionGet ticket action.
Get ticket statusGet ticket status.
Get ticket typeGet ticket type.
Get userGet user.
List agentsList agents.
List assetsList assets.
List customersList customers.
List prioritiesList priorities.
List sitesList sites.
List ticket actionsList ticket actions.
List ticket statusesList ticket statuses.
List ticket typesList ticket types.
List ticketsList tickets.
List usersList users.

Add ticket note

Add ticket note. Returns the service response.

Inputs

Ticketticket_idnumberRequired
Ticket id.
OutcomeoutcometextRequired
Outcome.
NotenotetextRequired
Note.
Sendemailsendemailtrue/false
Sendemail.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "assets": [],
    "id": 1,
    "note": "example",
    "outcome": "example",
    "ticket_id": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

Create customer

Create customer. Returns the service response.

Inputs

NamenametextRequired
Name.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "id": 1,
    "name": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Create site

Create site. Returns the service response.

Inputs

NamenametextRequired
Name.
Customerclient_idnumberRequired
Client id.
Client nameclient_nametext
Client name.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "client_id": 1,
    "clients": [],
    "id": 1,
    "name": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Create ticket

Create ticket. Returns the service response.

Inputs

SummarysummarytextRequired
Summary.
Detailsdetailstext
Details.
Status idstatus_idnumber
Status id.
Tickettype idtickettype_idnumber
Tickettype id.
Priority idpriority_idnumber
Priority id.
Customerclient_idnumber
Client id.
Client nameclient_nametext
Client name.
Sitesite_idnumber
Site id.
Record user idrecord_user_idnumber
User id.
Isimportantcontactisimportantcontacttrue/false
Isimportantcontact.
Firstnamefirstnametext
Firstname.
Actioncodeactioncodenumber
Actioncode.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "assets": [],
    "client_id": 1,
    "details": "example",
    "firstname": "example",
    "id": 1,
    "priority_id": 1,
    "site_id": 1,
    "status_id": 1,
    "summary": "example",
    "tickettype_id": 1,
    "user_id": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

Create user

Create user. Returns the service response.

Inputs

NamenametextRequired
Name.
Sitesite_idnumberRequired
Site id.
Client nameclient_nametext
Client name.
Firstnamefirstnametext
Firstname.
Surnamesurnametext
Surname.
Emailaddressemailaddresstext
Emailaddress.
Isimportantcontactisimportantcontacttrue/false
Isimportantcontact.
Priority idpriority_idnumber
Priority id.
Customerclient_idnumber
Client id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "assets": [],
    "client_id": 1,
    "clients": [],
    "emailaddress": "example",
    "firstname": "example",
    "id": 1,
    "name": "example",
    "priority_id": 1,
    "site_id": 1,
    "surname": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Get agent

Get agent. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

Get asset

Get asset. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "client_id": 1,
    "id": 1,
    "priority_id": 1,
    "site_id": 1,
    "status_id": 1,
    "users": []
  },
  "has_more": false,
  "next_cursor": "example"
}

Get customer

Get customer. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "id": 1,
    "name": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Get priority

Get priority. Returns the service response.

Inputs

IdidtextRequired
Id.

Outputs

dataobject
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

Get site

Get site. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "client_id": 1,
    "clients": [],
    "id": 1,
    "name": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Get ticket

Get ticket. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "assets": [],
    "client_id": 1,
    "details": "example",
    "firstname": "example",
    "id": 1,
    "priority_id": 1,
    "site_id": 1,
    "status_id": 1,
    "summary": "example",
    "tickettype_id": 1,
    "user_id": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

Get ticket action

Get ticket action. Returns the service response.

Inputs

IdidnumberRequired
Id.
Ticketticket_idnumber
Ticket id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "assets": [],
    "id": 1,
    "note": "example",
    "outcome": "example",
    "ticket_id": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

Get ticket status

Get ticket status. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

Get ticket type

Get ticket type. Returns the service response.

Inputs

IdidnumberRequired
Id.
Ticketticket_idnumber
Ticket id.

Outputs

dataobject
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

Get user

Get user. Returns the service response.

Inputs

IdidnumberRequired
Id.
Customerclient_idnumber
Client id.
Sitesite_idnumber
Site id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "assets": [],
    "client_id": 1,
    "clients": [],
    "emailaddress": "example",
    "firstname": "example",
    "id": 1,
    "name": "example",
    "priority_id": 1,
    "site_id": 1,
    "surname": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

List agents

List agents. Returns one page; use the next page cursor to continue.

Inputs

Customerclient_idnumber
Client id.
Orderordertext
Order.
Orderdescorderdesctrue/false
Orderdesc.
Page nopage_nonumber
Page no.
Page sizepage_sizenumber
Page size.
Searchsearchtext
Search.

Outputs

dataobject
The paginated agents.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "agents": [],
    "record_count": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

List assets

List assets. Returns one page; use the next page cursor to continue.

Inputs

Customerclient_idnumber
Client id.
Countcountnumber
Count.
Includeinactiveincludeinactivetrue/false
Includeinactive.
Orderordertext
Order.
Orderdescorderdesctrue/false
Orderdesc.
Page nopage_nonumber
Page no.
Page sizepage_sizenumber
Page size.
Searchsearchtext
Search.
Sitesite_idnumber
Site id.
Ticketticket_idnumber
Ticket id.
Record user idrecord_user_idnumber
User id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "assets": [],
    "page_no": 1,
    "page_size": 1,
    "record_count": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

List customers

List customers. Returns one page; use the next page cursor to continue.

Inputs

Countcountnumber
Count.
Includeinactiveincludeinactivetrue/false
Includeinactive.
Orderordertext
Order.
Orderdescorderdesctrue/false
Orderdesc.
Page nopage_nonumber
Page no.
Page sizepage_sizenumber
Page size.
Searchsearchtext
Search.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "clients": [],
    "page_no": 1,
    "page_size": 1,
    "record_count": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

List priorities

List priorities. Returns the service response.

Inputs

None.

Outputs

dataobject
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

List sites

List sites. Returns one page; use the next page cursor to continue.

Inputs

Customerclient_idnumber
Client id.
Countcountnumber
Count.
Includeinactiveincludeinactivetrue/false
Includeinactive.
Orderordertext
Order.
Orderdescorderdesctrue/false
Orderdesc.
Page nopage_nonumber
Page no.
Page sizepage_sizenumber
Page size.
Searchsearchtext
Search.
Sitesite_idnumber
Site id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "page_no": 1,
    "page_size": 1,
    "record_count": 1,
    "sites": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List ticket actions

List ticket actions. Returns the service response.

Inputs

Countcountnumber
Count.
Ticketticket_idnumber
Ticket id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "actions": [],
    "page_no": 1,
    "page_size": 1,
    "record_count": 1,
    "ticket_id": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

List ticket statuses

List ticket statuses. Returns the service response.

Inputs

Ticketticket_idnumber
Ticket id.

Outputs

dataobject
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

List ticket types

List ticket types. Returns the service response.

Inputs

Customerclient_idnumber
Client id.
Showinactiveshowinactivetrue/false
Showinactive.

Outputs

dataobject
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

List tickets

List tickets. Returns one page; use the next page cursor to continue.

Inputs

Customerclient_idnumber
Client id.
Countcountnumber
Count.
Orderordertext
Order.
Orderdescorderdesctrue/false
Orderdesc.
Page nopage_nonumber
Page no.
Page sizepage_sizenumber
Page size.
Searchsearchtext
Search.
Sitesite_idnumber
Site id.
Record user idrecord_user_idnumber
User id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "agents": [],
    "page_no": 1,
    "page_size": 1,
    "record_count": 1,
    "tickets": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List users

List users. Returns one page; use the next page cursor to continue.

Inputs

Customerclient_idnumber
Client id.
Countcountnumber
Count.
Includeinactiveincludeinactivetrue/false
Includeinactive.
Orderordertext
Order.
Orderdescorderdesctrue/false
Orderdesc.
Page nopage_nonumber
Page no.
Page sizepage_sizenumber
Page size.
Searchsearchtext
Search.
Sitesite_idnumber
Site id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "page_no": 1,
    "page_size": 1,
    "record_count": 1,
    "users": []
  },
  "has_more": false,
  "next_cursor": "example"
}

On this page