Halo REST API

https://nevis.halopsa.com/apidoc/
Admin
Halo REST API is a token-based, OAuth2-secured API that enables developers to build integrations and...
Tokens:19,947
Snippets:140
Trust Score:9.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### GET /Projects/{id}

Source: https://nevis.halopsa.com/apidoc/resources/projects

Retrieves a single project object by its ID.

```APIDOC
## GET /Projects/{id}

### Description
Returns a single project object based on the provided ID.

### Method
GET

### Endpoint
/Projects/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The Project's ID

#### Query Parameters
- **includedetails** (bool) - Optional - Whether to include extra objects in the response
- **includelastaction** (bool) - Optional - Whether to include the last action in the response
- **ticketidonly** (bool) - Optional - Returns only the ID fields of the Projects

### Response
#### Success Response (200)
- **root** (object) - The project object
```

--------------------------------

### GET /Actions

Source: https://nevis.halopsa.com/apidoc/resources/actions

Retrieves a list of actions based on specified filters.

```APIDOC
## GET /Actions

### Description
Returns an object containing the count of actions and an array of action objects.

### Method
GET

### Endpoint
/Actions

### Parameters
#### Query Parameters
- **count** (int) - Optional - Number of actions to get
- **ticket_id** (int) - Optional - Get actions for a single ticket
- **excludesys** (bool) - Optional - Exclude system actions
- **conversationonly** (bool) - Optional - Only get actions relating to the Agent to End User conversation
- **agentonly** (bool) - Optional - Only get actions done by Agents
- **supplieronly** (bool) - Optional - Only get actions relating to Suppliers
- **excludeprivate** (bool) - Optional - Only get public actions
- **includehtmlnote** (bool) - Optional - Include the action note HTML as part of the response
- **includehtmlemail** (bool) - Optional - Include the action email HTML as part of the response
- **includeattachments** (bool) - Optional - Include attachment details in the response
- **importantonly** (bool) - Optional - Only get important actions
- **slaonly** (bool) - Optional - Only get SLA hold and release actions
- **ischildnotes** (bool) - Optional - Only get actions from child tickets

### Response
#### Success Response (200)
- **root** (object) - Returns an object containing the count of actions and an array of action objects.
```

--------------------------------

### GET /Site

Source: https://nevis.halopsa.com/apidoc/resources/sites

Retrieves a list of Site records with optional filtering and pagination.

```APIDOC
## GET /Site

### Description
Returns an object containing the count of Sites and an array of Site objects.

### Method
GET

### Endpoint
/Site

### Parameters
#### Query Parameters
- **pageinate** (bool) - Optional - Whether to use Pagination in the response
- **page_size** (int) - Optional - When using Pagination, the size of the page
- **page_no** (int) - Optional - When using Pagination, the page number to return
- **order** (string) - Optional - The name of the field to order by
- **orderdesc** (bool) - Optional - Whether to order ascending or descending
- **search** (string) - Optional - Filter by Sites like your search string
- **toplevel_id** (int) - Optional - Filter by Sites belonging to a particular top level
- **client_id** (int) - Optional - Filter by Sites belonging to a particular customer
- **includeinactive** (bool) - Optional - Include inactive Sites in the response
- **includeactive** (bool) - Optional - Include active Sites in the response
- **include_custom_fields** (string) - Optional - Comma separated list of Custom Field IDs to include in the response
- **count** (int) - Optional - When not using pagination, the number of results to return
```

--------------------------------

### GET /auth/authorize

Source: https://nevis.halopsa.com/apidoc/authentication/code

Redirects the user to the Halo authorization server to initiate the authentication process.

```APIDOC
## GET /auth/authorize

### Description
Redirects the user to the Halo authorization server to obtain an access code.

### Method
GET

### Endpoint
/auth/authorize

### Parameters
#### Query Parameters
- **response_type** (string) - Required - Must be "code"
- **client_id** (string) - Required - Your application's client ID
- **redirect_uri** (string) - Required - Your application's redirect URI
- **scope** (string) - Required - Application permissions required (e.g., "all")
- **tenant** (string) - Optional - Required for hosted solutions
```

--------------------------------

### GET /tickets

Source: https://nevis.halopsa.com/apidoc/examples

Retrieve a list of tickets from the resource server.

```APIDOC
## GET /tickets

### Description
Retrieve a list of tickets from the resource server.

### Method
GET

### Endpoint
/tickets
```

--------------------------------

### GET /auth/authorize

Source: https://nevis.halopsa.com/apidoc/authentication/implicit

Redirects the user to the Halo authentication server to initiate the Implicit Grant flow.

```APIDOC
## GET /auth/authorize

### Description
Redirects the user to the Halo authentication server to initiate the Implicit Grant flow. Upon successful authentication, the user is redirected back to the specified redirect_uri with an access token.

### Method
GET

### Endpoint
/auth/authorize

### Parameters
#### Query Parameters
- **client_id** (string) - Required - The unique identifier for your application.
- **response_type** (string) - Required - Must be set to "token".
- **redirect_uri** (string) - Required - The URI to which the user is redirected after successful authentication.
- **scope** (string) - Required - The application permissions required (e.g., "all").
- **tenant** (string) - Optional - The tenant ID, required for hosted solutions.
```

--------------------------------

### GET /KBArticle

Source: https://nevis.halopsa.com/apidoc/resources/knowledgebase

Retrieves an array of knowledge base articles with optional pagination and filtering.

```APIDOC
## GET /KBArticle

### Description
Returns an array of knowledge base articles.

### Method
GET

### Endpoint
/KBArticle

### Parameters
#### Query Parameters
- **pageinate** (bool) - Optional - Whether to use Pagination in the response
- **page_size** (int) - Optional - When using Pagination, the size of the page
- **page_no** (int) - Optional - When using Pagination, the page number to return
- **order** (string) - Optional - The name of the field to order by
- **orderdesc** (bool) - Optional - Whether to order ascending or descending
- **search** (string) - Optional - Filter by Contracts like your search
- **count** (int) - Optional - Number of results to return if not using pagination

### Response
#### Success Response (200)
- **root** (object) - An array of knowledge base articles.
```

--------------------------------

### GET /Opportunities/{id}

Source: https://nevis.halopsa.com/apidoc/resources/opportunities

Retrieves a single opportunity object by its ID.

```APIDOC
## GET /Opportunities/{id}

### Description
Returns a single opportunity object based on the provided ID.

### Method
GET

### Endpoint
/Opportunities/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The opportunity's ID

#### Query Parameters
- **includedetails** (bool) - Optional - Whether to include extra objects in the response
- **includelastaction** (bool) - Optional - Whether to include the last action in the response
- **ticketidonly** (bool) - Optional - Returns only the ID fields (Ticket ID, SLA ID, Status ID, Client ID and Name and Lastincomingemail date) of the Opportunities (Not compatible with Pagination)

### Response
#### Success Response (200)
- Returns a single opportunity object.
```

--------------------------------

### GET /Projects

Source: https://nevis.halopsa.com/apidoc/resources/projects

Retrieves a list of Halo Project records. This endpoint supports various filtering, pagination, and inclusion options.

```APIDOC
## GET /Projects

### Description
Returns an object containing the count of projects and an array of project objects.

### Method
GET

### Endpoint
/Projects

### Parameters
#### Query Parameters
- **pageinate** (bool) - Optional - Whether to use Pagination in the response
- **page_size** (int) - Optional - When using Pagination, the size of the page
- **page_no** (int) - Optional - When using Pagination, the page number to return
- **order** (string) - Optional - The name of the field to order by
- **orderdesc** (bool) - Optional - Whether to order ascending or descending
- **ticketidonly** (bool) - Optional - Returns only the ID fields of the Projects (Not compatible with Pagination)
- **view_id** (int) - Optional - The ID of the filter profile to filter by
- **columns_id** (int) - Optional - The column profile ID
- **includecolumns** (bool) - Optional - Include column details in the response
- **includeslaactiondate** (bool) - Optional - Include the SLA action date in the response
- **includeslatimer** (bool) - Optional - Include SLA timer in the response
- **includetimetaken** (bool) - Optional - Include time taken in the response
- **includesupplier** (bool) - Optional - Include supplier details in the response
- **includerelease1** (bool) - Optional - Include release 1 details in the response
- **includerelease2** (bool) - Optional - Include release 2 details in the response
- **includerelease3** (bool) - Optional - Include release 3 details in the response
- **includechildids** (bool) - Optional - Include child entity IDs in the response
- **includenextactivitydate** (bool) - Optional - Include nextactivitydate in the response
- **list_id** (int) - Optional - Filters by the specified list
- **agent_id** (int) - Optional - Filters by the specified agent
- **status_id** (int) - Optional - Filters by the specified status
- **requesttype_id** (int) - Optional - Filters by the specified request type
- **supplier_id** (int) - Optional - Filters by the specified supplier
- **client_id** (int) - Optional - Filters by the specified client
- **site** (int) - Optional - Filters by the specified site
- **username** (string) - Optional - Filters by the specified user
- **user_id** (int) - Optional - Filters by the specified user
- **release_id** (int) - Optional - Filters by the specified release
- **asset_id** (int) - Optional - Filters by the specified asset
- **itil_requesttype_id** (int) - Optional - Filters by the specified ITIL request type
- **open_only** (bool) - Optional - Returns only open projects in the response
- **closed_only** (bool) - Optional - Returns only closed projects in the response
- **unlinked_only** (bool) - Optional - Returns only unlinked projects in the response
- **contract_id** (int) - Optional - Filters by the specified contract
- **withattachments** (bool) - Optional - Returns only projects with 1 or more attachment
- **team** (int array) - Optional - Returns projects based on Team ID's in the array
- **agent** (int array) - Optional - Returns projects based on Agent ID's in the array
- **status** (int array) - Optional - Returns projects based on status ID's in the array
- **requesttype** (int array) - Optional - Returns projects based on request type ID's in the array
- **itil_requesttype** (int array) - Optional - Returns projects based on ITIL request type ID's in the array
- **category_1** (int array) - Optional - Returns projects based on category 1 ID's in the array
- **category_2** (int array) - Optional - Returns projects based on category 2 ID's in the array
- **category_3** (int array) - Optional - Returns projects based on category 3 ID's in the array
- **category_4** (int array) - Optional - Returns projects based on category 4 ID's in the array
- **sla** (int array) - Optional - Returns projects based on SLA ID's in the array
- **priority** (int array) - Optional - Returns projects based on priority ID's in the array
- **products** (int array) - Optional - Returns projects based on product ID's in the array
- **flagged** (int array) - Optional - Returns projects based on flagged project ID's in the array
- **excludethese** (int array) - Optional - Excludes these projects from the response
- **search** (string) - Optional - Filters response based on the search string
- **searchactions** (bool) - Optional - Whether to search actions when using search
- **datesearch** (string) - Optional - The date field to search against
- **startdate** (string) - Optional - For use with the datesearch parameter
- **enddate** (string) - Optional - For use with the datesearch parameter

### Response
#### Success Response (200)
- **count** (int) - The total number of projects
- **projects** (array) - An array of project objects
```

--------------------------------

### GET /Site/{id}

Source: https://nevis.halopsa.com/apidoc/resources/sites

Retrieves a single Site object by its unique identifier.

```APIDOC
## GET /Site/{id}

### Description
Returns a single Site object.

### Method
GET

### Endpoint
/Site/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The Site's ID

#### Query Parameters
- **includedetails** (bool) - Optional - Whether to include extra objects in the response
- **includeactivity** (bool) - Optional - Whether to include site ticket activity in the response
```

--------------------------------

### GET /Item

Source: https://nevis.halopsa.com/apidoc/resources/items

Retrieves a list of items based on search criteria and pagination settings.

```APIDOC
## GET /Item

### Description
Returns an object containing the count of items and an array of item objects. Requires 'Agent' and 'Item Read' permissions.

### Method
GET

### Endpoint
/Item

### Parameters
#### Query Parameters
- **count** (int) - Optional - Number of records to return
- **search** (string) - Optional - Filters response based on the search string matching Name, Internal Reference, External Reference, Manufacturer SKU, Description, ID, Accounts ID and Item Group
- **include_custom_fields** (string) - Optional - Comma separated list of Custom Field IDs to include in the response
- **pageinate** (bool) - Optional - Whether to use Pagination in the response
- **page_size** (int) - Optional - When using Pagination, the size of the page
- **page_no** (int) - Optional - When using Pagination, the page number to return
- **orderby** (string) - Optional - The name of the first field to order by
- **orderbydesc** (bool) - Optional - Whether to order ascending or descending
- **orderby2** (string) - Optional - The name of the second field to order by
- **orderbydesc2** (bool) - Optional - Whether to order ascending or descending
- **orderby3** (string) - Optional - The name of the third field to order by
- **orderbydesc3** (bool) - Optional - Whether to order ascending or descending
- **orderby4** (string) - Optional - The name of the fourth field to order by
- **orderbydesc4** (bool) - Optional - Whether to order ascending or descending
- **orderby5** (string) - Optional - The name of the fifth field to order by
- **orderbydesc5** (bool) - Optional - Whether to order ascending or descending

### Response
#### Success Response (200)
- **root** (object) - Contains count and array of items
```

--------------------------------

### GET /Agent

Source: https://nevis.halopsa.com/apidoc/resources/agents

Retrieves an array of Agents based on optional filters.

```APIDOC
## GET /Agent

### Description
Returns an array of Agents. Permissions required: Agent.

### Method
GET

### Endpoint
/Agent

### Parameters
#### Query Parameters
- **team** (string) - Optional - Filter by Agents within a particular team
- **search** (string) - Optional - Filter by Agents with a name, email address or telephone number like your search
- **section_id** (int) - Optional - Filter by Agents within a particular team
- **department_id** (int) - Optional - Filter by Agents within a particular department
- **client_id** (int) - Optional - Filter by Agents who have access to a particular client
- **role** (string) - Optional - Filter by Agents who have a particular role. Requires an int passed as a string
- **includeenabled** (bool) - Optional - Include enabled Agents in the response
- **includedisabled** (bool) - Optional - Include disabled Agents in the response
- **includeunassigned** (bool) - Optional - Include the unassigned Agent in the response

### Response
#### Success Response (200)
- **root** (array) - An array of Agent objects
```

--------------------------------

### GET /Team

Source: https://nevis.halopsa.com/apidoc/resources/teams

Retrieves an array of teams based on optional filters.

```APIDOC
## GET /Team

### Description
Returns an array of Teams. Permissions required: Agent.

### Method
GET

### Endpoint
/Team

### Parameters
#### Query Parameters
- **type** (string) - Optional - Filter by team domain: reqs - tickets, opps - opportunities, prjs - projects
- **includeagentsforteams** (string) - Optional - Comma separated list of team names. Agents in these teams will be returned
- **memberonly** (bool) - Optional - Only returns sections that the current agent is a member of
- **showall** (bool) - Optional - Admin override to show all teams, overriding team permissions
- **showcounts** (bool) - Optional - Show the count of tickets in the response
- **domain** (string) - Optional - For use with counts: reqs - tickets, opps - opportunities, prjs - projects
- **view_id** (int) - Optional - For use with counts: the view ID to restrict the counts by
- **includeenabled** (bool) - Optional - Include enabled Teams in the response
- **includedisabled** (bool) - Optional - Include disabled Teams in the response
- **department_id** (int) - Optional - Filter Teams belonging to a particular department

### Response
#### Success Response (200)
- **root** (array) - List of team objects
```

--------------------------------

### GET /Status

Source: https://nevis.halopsa.com/apidoc/resources/status

Retrieves an array of Statuses based on optional filters.

```APIDOC
## GET /Status

### Description
Returns an array of Statuses. Permissions required: Agent.

### Method
GET

### Endpoint
/Status

### Parameters
#### Query Parameters
- **type** (string) - Optional - Filter by Status type e.g. 'ticket' returns all ticket statuses
- **showcounts** (bool) - Optional - Show the count of tickets in the response
- **domain** (string) - Optional - For use with counts: reqs - tickets, opps - opportunities, prjs - projects
- **view_id** (int) - Optional - For use with counts: the view ID to restrict the counts by
- **excludepending** (bool) - Optional - Exclude the pending closure status from the response
- **excludeclosed** (bool) - Optional - Exclude the closed status from the response

### Response
#### Success Response (200)
- **root** (array) - An array of Status objects.
```

--------------------------------

### GET /Supplier

Source: https://nevis.halopsa.com/apidoc/resources/suppliers

Retrieves an array of suppliers based on optional query filters.

```APIDOC
## GET /Supplier

### Description
Returns an array of suppliers. Requires 'Agent' and 'Supplier Read' permissions.

### Method
GET

### Endpoint
/Supplier

### Parameters
#### Query Parameters
- **pageinate** (bool) - Optional - Whether to use Pagination in the response
- **page_size** (int) - Optional - When using Pagination, the size of the page
- **page_no** (int) - Optional - When using Pagination, the page number to return
- **order** (string) - Optional - The name of the field to order by
- **orderdesc** (bool) - Optional - Whether to order ascending or descending
- **search** (string) - Optional - Filter by Suppliers like your search
- **count** (int) - Optional - Number of results to return if not using pagination
- **toplevel_id** (int) - Optional - Filter by suppliers belonging to a particular top level
- **includeactive** (bool) - Optional - Include active suppliers in the response
- **includeinactive** (bool) - Optional - Include inactive suppliers in the response

### Response
#### Success Response (200)
- **root** (object) - An array of supplier objects
```

--------------------------------

### GET /Status/{id}

Source: https://nevis.halopsa.com/apidoc/resources/status

Retrieves a single Status object by its ID.

```APIDOC
## GET /Status/{id}

### Description
Returns a single Status object. Permissions required: Agent.

### Method
GET

### Endpoint
/Status/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The Status ID

#### Query Parameters
- **includedetails** (bool) - Optional - Whether to include extra objects in the response

### Response
#### Success Response (200)
- **root** (object) - A single Status object.
```

--------------------------------

### GET /Team/{id}

Source: https://nevis.halopsa.com/apidoc/resources/teams

Retrieves a single team object by its ID.

```APIDOC
## GET /Team/{id}

### Description
Returns a single Team object. Permissions required: Agent.

### Method
GET

### Endpoint
/Team/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The Team's ID

#### Query Parameters
- **includedetails** (bool) - Optional - Whether to include extra objects in the response
- **includeagents** (bool) - Optional - Whether to include Agents in the response

### Response
#### Success Response (200)
- **root** (object) - The team object
```

--------------------------------

### GET /Asset

Source: https://nevis.halopsa.com/apidoc/resources/assets

Retrieves a list of Asset records based on optional filters and pagination settings.

```APIDOC
## GET /Asset

### Description
Returns an object containing the count of Assets and an array of Asset objects.

### Method
GET

### Endpoint
/Asset

### Parameters
#### Query Parameters
- **pageinate** (bool) - Optional - Whether to use Pagination in the response
- **page_size** (int) - Optional - When using Pagination, the size of the page
- **page_no** (int) - Optional - When using Pagination, the page number to return
- **order** (string) - Optional - The name of the field to order by
- **orderdesc** (bool) - Optional - Whether to order ascending or descending
- **search** (string) - Optional - Filter by Assets with an asset field like your search
- **ticket_id** (int) - Optional - Filter by Assets belonging to a particular ticket
- **client_id** (int) - Optional - Filter by Assets belonging to a particular client
- **site_id** (int) - Optional - Filter by Assets belonging to a particular site
- **username** (string) - Optional - Filter by Assets belonging to a particular user
- **assetgroup_id** (int) - Optional - Filter by Assets belonging to a particular Asset group
- **assettype_id** (int) - Optional - Filter by Assets belonging to a particular Asset type
- **linkedto_id** (int) - Optional - Filter by Assets linked to a particular Asset
- **includeinactive** (bool) - Optional - Include inactive Assets in the response
- **includeactive** (bool) - Optional - Include active Assets in the response
- **includechildren** (bool) - Optional - Include child Assets in the response
- **contract_id** (int) - Optional - Filter by Assets assigned to a particular contract
- **includechangehistorylastupdated** (bool) - Optional - Includes the date of the latest change history record for the asset

### Response
#### Success Response (200)
- **count** (int) - The number of assets returned
- **assets** (array) - An array of Asset objects
```

--------------------------------

### Get Appointments List

Source: https://nevis.halopsa.com/apidoc/resources/appointments

Retrieves an array of appointments. Requires Agent and Calendar Read permissions.

```json
"root":{}
```

--------------------------------

### GET /Actions/{id}

Source: https://nevis.halopsa.com/apidoc/resources/actions

Retrieves a single action object by its ID.

```APIDOC
## GET /Actions/{id}

### Description
Returns a single action object.

### Method
GET

### Endpoint
/Actions/{id}

### Parameters
#### Query Parameters
- **id** (int) - Required - The action ID
- **ticket_id** (int) - Required - The ticket ID
- **includeemail** (bool) - Optional - Include the plain text and HTML email body in the response
- **includedetails** (bool) - Optional - Whether to include extra objects
- **mostrecent** (bool) - Optional - Get the most recent action on the ticket
- **agentonly** (bool) - Optional - Only get actions done by Agents
- **emailonly** (bool) - Optional - Only get email actions
- **nonsystem** (bool) - Optional - Only get non system actions

### Response
#### Success Response (200)
- **root** (object) - Returns a single action object.
```

--------------------------------

### GET /Appointment/{id}

Source: https://nevis.halopsa.com/apidoc/resources/appointments

Retrieves a single appointment object by its ID.

```APIDOC
## GET /Appointment/{id}

### Description
Returns a single appointment object. Requires Agent and Calendar Read permissions.

### Method
GET

### Endpoint
/Appointment/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The Appointment ID

#### Query Parameters
- **includedetails** (bool) - Optional - Whether to include extra objects in the response

### Response
#### Success Response (200)
- **root** (object) - The appointment object.
```

--------------------------------

### GET /Invoice/{id}

Source: https://nevis.halopsa.com/apidoc/resources/invoices

Retrieves a single invoice object by its ID.

```APIDOC
## GET /Invoice/{id}

### Description
Returns a single invoice object.

### Method
GET

### Endpoint
/Invoice/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The Invoice's ID
```

--------------------------------

### GET /Asset/{id}

Source: https://nevis.halopsa.com/apidoc/resources/assets

Retrieves a single Asset record by its unique identifier.

```APIDOC
## GET /Asset/{id}

### Description
Returns a single Asset object.

### Method
GET

### Endpoint
/Asset/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The Asset's ID

#### Query Parameters
- **includedetails** (bool) - Optional - Whether to include extra objects in the response
- **includediagramdetails** (bool) - Optional - Whether to include diagram details in the response

### Response
#### Success Response (200)
- **asset** (object) - The requested Asset object
```

--------------------------------

### GET /Appointment

Source: https://nevis.halopsa.com/apidoc/resources/appointments

Retrieves an array of appointments based on optional query filters.

```APIDOC
## GET /Appointment

### Description
Returns an array of appointments. Requires Agent and Calendar Read permissions.

### Method
GET

### Endpoint
/Appointment

### Parameters
#### Query Parameters
- **showall** (bool) - Optional - Admin override to return all appointments
- **start_date** (string) - Optional - Return appointments with a start date greater than this value
- **end_date** (string) - Optional - Return appointments with an end date greater than this value
- **agents** (string) - Optional - Comma separated list of agent IDs. Returns these agent's appointments
- **showholidays** (bool) - Optional - Include the appointment type 'holiday' in the response
- **showprojects** (bool) - Optional - Include projects in the response
- **showchanges** (bool) - Optional - Include change requests in the response
- **showappointments** (bool) - Optional - Include appointments in the response
- **showshifts** (bool) - Optional - Include shifts in the response
- **search** (string) - Optional - Return appointments like this search string
- **appointmentsonly** (bool) - Optional - Only return appointments in the response
- **tasksonly** (bool) - Optional - Only return tasks in the response
- **hidecompleted** (bool) - Optional - Exclude completed appointments from the response
- **ticket_id** (int) - Optional - Return appointments assigned to a particular ticket

### Response
#### Success Response (200)
- **root** (object) - An array of appointment objects.
```

--------------------------------

### GET /Supplier/{id}

Source: https://nevis.halopsa.com/apidoc/resources/suppliers

Retrieves a single supplier object by its unique identifier.

```APIDOC
## GET /Supplier/{id}

### Description
Returns a single supplier object. Requires 'Agent' and 'Supplier Read' permissions.

### Method
GET

### Endpoint
/Supplier/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The Supplier ID

#### Query Parameters
- **includedetails** (bool) - Optional - Whether to include extra objects in the response

### Response
#### Success Response (200)
- **root** (object) - The supplier object
```

--------------------------------

### GET /Client

Source: https://nevis.halopsa.com/apidoc/resources/clients

Retrieves a list of Client records. Supports pagination, filtering by search string, and status inclusion.

```APIDOC
## GET /Client

### Description
Returns an object containing the count of Clients and an array of Client objects.

### Method
GET

### Endpoint
/Client

### Parameters
#### Query Parameters
- **pageinate** (bool) - Optional - Whether to use Pagination in the response
- **page_size** (int) - Optional - When using Pagination, the size of the page
- **page_no** (int) - Optional - When using Pagination, the page number to return
- **order** (string) - Optional - The name of the field to order by
- **orderdesc** (bool) - Optional - Whether to order ascending or descending
- **search** (string) - Optional - Filter by Customers like your search string
- **toplevel_id** (int) - Optional - Filter by Customers belonging to a particular top level
- **includeinactive** (bool) - Optional - Include inactive Customers in the response
- **includeactive** (bool) - Optional - Include active Customers in the response
- **include_custom_fields** (string) - Optional - Comma separated list of Custom Field IDs to include in the response
- **count** (int) - Optional - When not using pagination, the number of results to return
- **include_website** (bool) - Optional - Will include the website field against the clients in the response

### Response
#### Success Response (200)
- **root** (object) - Contains count and array of Client objects
```

--------------------------------

### GET /Users/{id}

Source: https://nevis.halopsa.com/apidoc/resources/users

Retrieves a single User record by its unique identifier.

```APIDOC
## GET /Users/{id}

### Description
Returns a single User object.

### Method
GET

### Endpoint
/Users/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The User's ID

#### Query Parameters
- **includedetails** (bool) - Optional - Whether to include extra objects in the response
- **includeactivity** (bool) - Optional - Whether to include User's ticket activity in the response
- **includepopups** (bool) - Optional - Whether to include customer pop ups in the response

### Response
#### Success Response (200)
- **root** (object) - A single User object
```

--------------------------------

### Search Users with Advanced Filters

Source: https://nevis.halopsa.com/apidoc/resources/users

Example of using the advanced_search parameter to filter users by specific fields.

```json
advanced_search=[{"filter_name":"firstname","filter_type":4,"filter_value":"Admin"}]
```

--------------------------------

### GET /Agent/{id}

Source: https://nevis.halopsa.com/apidoc/resources/agents

Retrieves a single agent object by its ID.

```APIDOC
## GET /Agent/{id}

### Description
Returns a single agent object. Permissions required: Agent.

### Method
GET

### Endpoint
/Agent/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The Agent ID

#### Query Parameters
- **includedetails** (bool) - Optional - Whether to include extra objects, such as teams and roles

### Response
#### Success Response (200)
- **root** (object) - A single agent object
```

--------------------------------

### GET /Agent/me

Source: https://nevis.halopsa.com/apidoc/resources/agents

Retrieves the agent object associated with the current access token.

```APIDOC
## GET /Agent/me

### Description
Returns a single agent object based on the agent that the access token is for. Permissions required: Agent.

### Method
GET

### Endpoint
/Agent/me

### Response
#### Success Response (200)
- **root** (object) - The current agent object
```

--------------------------------

### GET /Invoice

Source: https://nevis.halopsa.com/apidoc/resources/invoices

Retrieves a list of invoice records based on optional filters.

```APIDOC
## GET /Invoice

### Description
Returns an object containing the count of invoices and an array of invoice objects.

### Method
GET

### Endpoint
/Invoice

### Parameters
#### Query Parameters
- **count** (int) - Optional - Number of records to return
- **search** (string) - Optional - Filters response based on the search string
- **pageinate** (bool) - Optional - Whether to use Pagination in the response
- **page_size** (int) - Optional - When using Pagination, the size of the page
- **page_no** (int) - Optional - When using Pagination, the page number to return
- **orderby** (string) - Optional - The name of the first field to order by
- **orderdesc** (bool) - Optional - Whether to order ascending or descending
- **orderby2** (string) - Optional - The name of the second field to order by
- **orderdesc2** (bool) - Optional - Whether to order ascending or descending
- **orderby3** (string) - Optional - The name of the third field to order by
- **orderdesc3** (bool) - Optional - Whether to order ascending or descending
- **orderby4** (string) - Optional - The name of the fourth field to order by
- **orderdesc4** (bool) - Optional - Whether to order ascending or descending
- **orderby5** (string) - Optional - The name of the fifth field to order by
- **orderdesc5** (bool) - Optional - Whether to order ascending or descending
- **ticket_id** (int) - Optional - Filters by the specified ticket
- **client_id** (int) - Optional - Filters by the specified client
- **site_id** (int) - Optional - Filters by the specified site
- **user_id** (int) - Optional - Filters by the specified user
- **postedonly** (bool) - Optional - Whether to only inlcude posted invoices
- **notpostedonly** (bool) - Optional - Whether to only inlcude not posted invoices
```

--------------------------------

### GET /KBArticle/{id}

Source: https://nevis.halopsa.com/apidoc/resources/knowledgebase

Retrieves a single knowledge base article object by its ID.

```APIDOC
## GET /KBArticle/{id}

### Description
Returns a single knowledge base article object.

### Method
GET

### Endpoint
/KBArticle/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The KB article ID

#### Query Parameters
- **includedetails** (bool) - Optional - Whether to include extra objects in the response

### Response
#### Success Response (200)
- **root** (object) - The knowledge base article object.
```

--------------------------------

### GET /Report/{id}

Source: https://nevis.halopsa.com/apidoc/resources/reports

Retrieves a single report object by its unique identifier.

```APIDOC
## GET /Report/{id}

### Description
Returns a single report object.

### Method
GET

### Endpoint
/Report/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The Report's ID

#### Query Parameters
- **includedetails** (bool) - Optional - Whether to include extra objects in the response
- **loadreport** (bool) - Optional - Whether to include the report data in the response
```

--------------------------------

### GET /ClientContract

Source: https://nevis.halopsa.com/apidoc/resources/contracts

Retrieves an array of contracts based on optional filtering and pagination parameters.

```APIDOC
## GET /ClientContract

### Description
Returns an array of contracts. Requires 'Customers Read' permission.

### Method
GET

### Endpoint
/ClientContract

### Parameters
#### Query Parameters
- **pageinate** (bool) - Optional - Whether to use Pagination in the response
- **page_size** (int) - Optional - When using Pagination, the size of the page
- **page_no** (int) - Optional - When using Pagination, the page number to return
- **order** (string) - Optional - The name of the field to order by
- **orderdesc** (bool) - Optional - Whether to order ascending or descending
- **search** (string) - Optional - Filter by Contracts like your search
- **count** (int) - Optional - Number of results to return if not using pagination
- **client_id** (int) - Optional - Filter by contracts belonging to a particular customer

### Response
#### Success Response (200)
- **root** (object) - Array of contracts
```

--------------------------------

### GET /Report

Source: https://nevis.halopsa.com/apidoc/resources/reports

Retrieves a list of report records based on optional filters and pagination settings.

```APIDOC
## GET /Report

### Description
Returns an object containing the count of reports and an array of report objects.

### Method
GET

### Endpoint
/Report

### Parameters
#### Query Parameters
- **count** (int) - Optional - Number of records to return
- **search** (string) - Optional - Filters response based on the search string
- **pageinate** (bool) - Optional - Whether to use Pagination in the response
- **page_size** (int) - Optional - When using Pagination, the size of the page
- **page_no** (int) - Optional - When using Pagination, the page number to return
- **orderby** (string) - Optional - The name of the first field to order by
- **orderbydesc** (bool) - Optional - Whether to order ascending or descending
- **orderby2** (string) - Optional - The name of the second field to order by
- **orderbydesc2** (bool) - Optional - Whether to order ascending or descending
- **orderby3** (string) - Optional - The name of the third field to order by
- **orderbydesc3** (bool) - Optional - Whether to order ascending or descending
- **orderby4** (string) - Optional - The name of the fourth field to order by
- **orderbydesc4** (bool) - Optional - Whether to order ascending or descending
- **orderby5** (string) - Optional - The name of the fifth field to order by
- **orderbydesc5** (bool) - Optional - Whether to order ascending or descending
- **ticket_id** (int) - Optional - Filters by the specified ticket
- **client_id** (int) - Optional - Filters by the specified client
- **site_id** (int) - Optional - Filters by the specified site
- **user_id** (int) - Optional - Filters by the specified user
- **reportgroup_id** (int) - Optional - Filters by the specified report group
- **chartonly** (bool) - Optional - Whether to return only records for reports that include graphs
```

--------------------------------

### GET /Item/{id}

Source: https://nevis.halopsa.com/apidoc/resources/items

Retrieves a single item object by its unique identifier.

```APIDOC
## GET /Item/{id}

### Description
Returns a single item object. Requires 'Agent' and 'Item Read' permissions.

### Method
GET

### Endpoint
/Item/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The Item's ID

#### Query Parameters
- **includedetails** (bool) - Optional - Whether to include extra objects in the response

### Response
#### Success Response (200)
- **root** (object) - The item object
```

--------------------------------

### GET /Attachment

Source: https://nevis.halopsa.com/apidoc/resources/attachments

Retrieves an array of attachments based on optional query filters.

```APIDOC
## GET /Attachment

### Description
Returns an array of attachments. You can filter the results using query parameters.

### Method
GET

### Endpoint
/Attachment

### Parameters
#### Query Parameters
- **ticket_id** (int) - Optional - Returns attachments from the ticket ID specified
- **action_id** (int) - Optional - Returns attachments from the action ID specified (requires ticket_id)
- **type** (int) - Optional - Returns attachments of the specified type
- **unique_id** (int) - Optional - Returns an attachment with the unique ID specified
- **printit** (bool) - Optional - When true, it will return the printed memory stream in plain text. When false, it will return a URL to the specified attachment.

### Response
#### Success Response (200)
- **root** (object) - An array of attachment objects.
```
Tokens:
Raw