HaloPSA
App · 25 actions
Read HaloPSA service records and create tickets, customers, sites, users and ticket notes.
Actions
| Action | What it does |
|---|---|
| Add ticket note | Add ticket note. |
| Create customer | Create customer. |
| Create site | Create site. |
| Create ticket | Create ticket. |
| Create user | Create user. |
| Get agent | Get agent. |
| Get asset | Get asset. |
| Get customer | Get customer. |
| Get priority | Get priority. |
| Get site | Get site. |
| Get ticket | Get ticket. |
| Get ticket action | Get ticket action. |
| Get ticket status | Get ticket status. |
| Get ticket type | Get ticket type. |
| Get user | Get user. |
| List agents | List agents. |
| List assets | List assets. |
| List customers | List customers. |
| List priorities | List priorities. |
| List sites | List sites. |
| List ticket actions | List ticket actions. |
| List ticket statuses | List ticket statuses. |
| List ticket types | List ticket types. |
| List tickets | List tickets. |
| List users | List users. |
Add ticket note
Add ticket note. Returns the service response.
Inputs
- Ticket
ticket_idnumberRequired - Ticket id.
- Outcome
outcometextRequired - Outcome.
- Note
notetextRequired - Note.
- Sendemail
sendemailtrue/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
- Name
nametextRequired - 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
- Name
nametextRequired - Name.
- Customer
client_idnumberRequired - Client id.
- Client name
client_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
- Summary
summarytextRequired - Summary.
- Details
detailstext - Details.
- Status id
status_idnumber - Status id.
- Tickettype id
tickettype_idnumber - Tickettype id.
- Priority id
priority_idnumber - Priority id.
- Customer
client_idnumber - Client id.
- Client name
client_nametext - Client name.
- Site
site_idnumber - Site id.
- Record user id
record_user_idnumber - User id.
- Isimportantcontact
isimportantcontacttrue/false - Isimportantcontact.
- Firstname
firstnametext - Firstname.
- Actioncode
actioncodenumber - 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
- Name
nametextRequired - Name.
- Site
site_idnumberRequired - Site id.
- Client name
client_nametext - Client name.
- Firstname
firstnametext - Firstname.
- Surname
surnametext - Surname.
- Emailaddress
emailaddresstext - Emailaddress.
- Isimportantcontact
isimportantcontacttrue/false - Isimportantcontact.
- Priority id
priority_idnumber - Priority id.
- Customer
client_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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idtextRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - Id.
- Ticket
ticket_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
- Id
idnumberRequired - 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
- Id
idnumberRequired - Id.
- Ticket
ticket_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
- Id
idnumberRequired - Id.
- Customer
client_idnumber - Client id.
- Site
site_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
- Customer
client_idnumber - Client id.
- Order
ordertext - Order.
- Orderdesc
orderdesctrue/false - Orderdesc.
- Page no
page_nonumber - Page no.
- Page size
page_sizenumber - Page size.
- Search
searchtext - 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
- Customer
client_idnumber - Client id.
- Count
countnumber - Count.
- Includeinactive
includeinactivetrue/false - Includeinactive.
- Order
ordertext - Order.
- Orderdesc
orderdesctrue/false - Orderdesc.
- Page no
page_nonumber - Page no.
- Page size
page_sizenumber - Page size.
- Search
searchtext - Search.
- Site
site_idnumber - Site id.
- Ticket
ticket_idnumber - Ticket id.
- Record user id
record_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
- Count
countnumber - Count.
- Includeinactive
includeinactivetrue/false - Includeinactive.
- Order
ordertext - Order.
- Orderdesc
orderdesctrue/false - Orderdesc.
- Page no
page_nonumber - Page no.
- Page size
page_sizenumber - Page size.
- Search
searchtext - 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
- Customer
client_idnumber - Client id.
- Count
countnumber - Count.
- Includeinactive
includeinactivetrue/false - Includeinactive.
- Order
ordertext - Order.
- Orderdesc
orderdesctrue/false - Orderdesc.
- Page no
page_nonumber - Page no.
- Page size
page_sizenumber - Page size.
- Search
searchtext - Search.
- Site
site_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
- Count
countnumber - Count.
- Ticket
ticket_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
- Ticket
ticket_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
- Customer
client_idnumber - Client id.
- Showinactive
showinactivetrue/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
- Customer
client_idnumber - Client id.
- Count
countnumber - Count.
- Order
ordertext - Order.
- Orderdesc
orderdesctrue/false - Orderdesc.
- Page no
page_nonumber - Page no.
- Page size
page_sizenumber - Page size.
- Search
searchtext - Search.
- Site
site_idnumber - Site id.
- Record user id
record_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
- Customer
client_idnumber - Client id.
- Count
countnumber - Count.
- Includeinactive
includeinactivetrue/false - Includeinactive.
- Order
ordertext - Order.
- Orderdesc
orderdesctrue/false - Orderdesc.
- Page no
page_nonumber - Page no.
- Page size
page_sizenumber - Page size.
- Search
searchtext - Search.
- Site
site_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"
}