# HaloPSA

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

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/halo-psa

## Actions

### Add ticket note

Add ticket note. Returns the service response.

**Inputs**

- Ticket (`ticket_id`, number, required): Ticket id.
- Outcome (`outcome`, text, required): Outcome.
- Note (`note`, text, required): Note.
- Sendemail (`sendemail`, true/false): Sendemail.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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 (`name`, text, required): Name.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "data": {
    "id": 1,
    "name": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Create site

Create site. Returns the service response.

**Inputs**

- Name (`name`, text, required): Name.
- Customer (`client_id`, number, required): Client id.
- Client name (`client_name`, text): Client name.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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 (`summary`, text, required): Summary.
- Details (`details`, text): Details.
- Status id (`status_id`, number): Status id.
- Tickettype id (`tickettype_id`, number): Tickettype id.
- Priority id (`priority_id`, number): Priority id.
- Customer (`client_id`, number): Client id.
- Client name (`client_name`, text): Client name.
- Site (`site_id`, number): Site id.
- Record user id (`record_user_id`, number): User id.
- Isimportantcontact (`isimportantcontact`, true/false): Isimportantcontact.
- Firstname (`firstname`, text): Firstname.
- Actioncode (`actioncode`, number): Actioncode.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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 (`name`, text, required): Name.
- Site (`site_id`, number, required): Site id.
- Client name (`client_name`, text): Client name.
- Firstname (`firstname`, text): Firstname.
- Surname (`surname`, text): Surname.
- Emailaddress (`emailaddress`, text): Emailaddress.
- Isimportantcontact (`isimportantcontact`, true/false): Isimportantcontact.
- Priority id (`priority_id`, number): Priority id.
- Customer (`client_id`, number): Client id.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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 (`id`, number, required): Id.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}
```

### Get asset

Get asset. Returns the service response.

**Inputs**

- Id (`id`, number, required): Id.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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 (`id`, number, required): Id.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "data": {
    "id": 1,
    "name": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get priority

Get priority. Returns the service response.

**Inputs**

- Id (`id`, text, required): Id.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}
```

### Get site

Get site. Returns the service response.

**Inputs**

- Id (`id`, number, required): Id.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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 (`id`, number, required): Id.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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 (`id`, number, required): Id.
- Ticket (`ticket_id`, number): Ticket id.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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 (`id`, number, required): Id.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}
```

### Get ticket type

Get ticket type. Returns the service response.

**Inputs**

- Id (`id`, number, required): Id.
- Ticket (`ticket_id`, number): Ticket id.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}
```

### Get user

Get user. Returns the service response.

**Inputs**

- Id (`id`, number, required): Id.
- Customer (`client_id`, number): Client id.
- Site (`site_id`, number): Site id.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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_id`, number): Client id.
- Order (`order`, text): Order.
- Orderdesc (`orderdesc`, true/false): Orderdesc.
- Page no (`page_no`, number): Page no.
- Page size (`page_size`, number): Page size.
- Search (`search`, text): Search.

**Outputs**

- `data` (object): The paginated agents.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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_id`, number): Client id.
- Count (`count`, number): Count.
- Includeinactive (`includeinactive`, true/false): Includeinactive.
- Order (`order`, text): Order.
- Orderdesc (`orderdesc`, true/false): Orderdesc.
- Page no (`page_no`, number): Page no.
- Page size (`page_size`, number): Page size.
- Search (`search`, text): Search.
- Site (`site_id`, number): Site id.
- Ticket (`ticket_id`, number): Ticket id.
- Record user id (`record_user_id`, number): User id.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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 (`count`, number): Count.
- Includeinactive (`includeinactive`, true/false): Includeinactive.
- Order (`order`, text): Order.
- Orderdesc (`orderdesc`, true/false): Orderdesc.
- Page no (`page_no`, number): Page no.
- Page size (`page_size`, number): Page size.
- Search (`search`, text): Search.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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**

- `data` (object): Data.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}
```

### List sites

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

**Inputs**

- Customer (`client_id`, number): Client id.
- Count (`count`, number): Count.
- Includeinactive (`includeinactive`, true/false): Includeinactive.
- Order (`order`, text): Order.
- Orderdesc (`orderdesc`, true/false): Orderdesc.
- Page no (`page_no`, number): Page no.
- Page size (`page_size`, number): Page size.
- Search (`search`, text): Search.
- Site (`site_id`, number): Site id.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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 (`count`, number): Count.
- Ticket (`ticket_id`, number): Ticket id.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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_id`, number): Ticket id.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}
```

### List ticket types

List ticket types. Returns the service response.

**Inputs**

- Customer (`client_id`, number): Client id.
- Showinactive (`showinactive`, true/false): Showinactive.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}
```

### List tickets

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

**Inputs**

- Customer (`client_id`, number): Client id.
- Count (`count`, number): Count.
- Order (`order`, text): Order.
- Orderdesc (`orderdesc`, true/false): Orderdesc.
- Page no (`page_no`, number): Page no.
- Page size (`page_size`, number): Page size.
- Search (`search`, text): Search.
- Site (`site_id`, number): Site id.
- Record user id (`record_user_id`, number): User id.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "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_id`, number): Client id.
- Count (`count`, number): Count.
- Includeinactive (`includeinactive`, true/false): Includeinactive.
- Order (`order`, text): Order.
- Orderdesc (`orderdesc`, true/false): Orderdesc.
- Page no (`page_no`, number): Page no.
- Page size (`page_size`, number): Page size.
- Search (`search`, text): Search.
- Site (`site_id`, number): Site id.

**Outputs**

- `data` (object): The complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page cursor.

**Example output**

```json
{
  "data": {
    "page_no": 1,
    "page_size": 1,
    "record_count": 1,
    "users": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```
