System Config Endpoints (cont.)
Attachments & Documents
Attachment
File attachments on tickets, actions, and other entities.
GET /Attachment — List attachments. Key parameters:
| Parameter | Type | Description |
|---|---|---|
ticket_id | integer | Return attachments for this ticket. |
action_id | integer | Return attachments from this action (requires ticket_id). |
type | integer | Return attachments of this type. |
filetype | string | Return attachments of this file extension. |
unique_id | integer | Return the attachment with this unique ID. |
one_attachment_id | integer | Return a single attachment by ID. |
portal | integer | Portal context filter. |
idonly | boolean | Return IDs only. |
isxlsimport | boolean | Filter to XLS import attachments. |
domotzagents | boolean | Filter to Domotz agent attachments. |
token | string | Authentication token for unauthenticated access. |
| Pagination | — | page_no, page_size, pageinate, count, order/orderdesc (×5). |
| Method | Path | Description |
|---|---|---|
POST | /Attachment | Upload a file attachment. |
GET | /Attachment/{id} | Get single attachment. Optional: includedetails, childticketid, token. |
DELETE | /Attachment/{id} | Delete an attachment. |
GET | /Attachment/nhserver/{id} | Download via NHServer. Optional: token. |
Image sub-endpoints:
| Method | Path | Description |
|---|---|---|
GET | /Attachment/image/{id} | Get an inline image by GUID. |
DELETE | /Attachment/image/{id} | Delete an inline image. |
GET | /Attachment/image | Get image with token and nonce params. |
POST | /Attachment/image | Upload an inline image. |
S3 / Document sub-endpoints:
| Method | Path | Description |
|---|---|---|
POST | /Attachment/GetS3PresignedURL | Get a presigned S3 URL for direct upload. |
POST | /Attachment/PresignedURLUploadComplete | Confirm an S3 presigned upload is complete. |
GET | /Attachment/document/{id} | Get a document attachment. |
DELETE | /Attachment/document/{id} | Delete a document attachment. |
POST | /Attachment/document | Upload a document attachment. |
DocumentCreation
POST /DocumentCreation — Trigger document creation from a template.
Asset Types & Mapping
Xtype (AssetType)
Asset type definitions.
GET /AssetType — List asset types. Key params: assetgroup_id (integer), type (string), tickettype_id (integer), setuplist (boolean), resourcesonly (boolean), can_create_only / can_edit_only (boolean), fixedassetgroups (boolean), include_current (boolean).
| Method | Path | Description |
|---|---|---|
POST | /AssetType | Create or update an asset type. |
GET | /AssetType/{id} | Get single asset type. |
DELETE | /AssetType/{id} | Delete an asset type. |
Generic (AssetGroup)
Asset group categories.
Standard CRUD: GET /AssetGroup, POST /AssetGroup, GET /AssetGroup/{id}, DELETE /AssetGroup/{id}.
XTypeMapping (AssetTypeMappings)
Mappings between asset types and external systems.
| Method | Path | Description |
|---|---|---|
GET | /AssetTypeMappings | List all type mappings. |
GET | /AssetTypeMappings/{id} | Get single mapping. |
XTypeRole
GET /XtypeRole — List asset type roles. Params: xtype_id (integer), xtyperole_id (integer).
TypeInfo (AssetTypeInfo)
GET /AssetTypeInfo — List asset type info metadata. Same params as GET /AssetType.
Data Import & Export
ImportCsv
CSV import job definitions.
| Method | Path | Description |
|---|---|---|
GET | /ImportCSV | List import definitions. Params: includedetails (boolean), type_id (integer). |
POST | /ImportCSV | Create or update an import definition. |
GET | /ImportCSV/{id} | Get single definition. |
DELETE | /ImportCSV/{id} | Delete a definition. |
CSVTemplate
Templates for CSV data import.
Standard CRUD: GET /CSVTemplate, POST /CSVTemplate, GET /CSVTemplate/{id}, DELETE /CSVTemplate/{id}.
SQLImport
SQL-based import configurations.
GET /SQLImport — List SQL imports. Params: clientidoverride (string), integratorenabled (boolean), showpositiveonly (boolean).
Standard CRUD: POST /SQLImport, GET /SQLImport/{id}, DELETE /SQLImport/{id}.
PDF & Document Templates
PdfTemplate
PDF output templates.
GET /PdfTemplate — List PDF templates. Params: type (string), licencename (string).
Standard CRUD: POST /PdfTemplate, GET /PdfTemplate/{id}, DELETE /PdfTemplate/{id}.
PdfTemplateRepository
Read-only repository of shared PDF templates.
| Method | Path | Description |
|---|---|---|
GET | /PdfTemplateRepository | List repository templates. Params: type, licencename. |
GET | /PdfTemplateRepository/{id} | Get single repository template. |
Branding & Language
StyleProfile
UI style profiles (branding/theme configurations).
Standard CRUD: GET /StyleProfile, POST /StyleProfile, GET /StyleProfile/{id}, DELETE /StyleProfile/{id}.
PublishProfiles
Portal publish profiles.
Standard CRUD: GET /PublishProfiles, POST /PublishProfiles, GET /PublishProfiles/{id}, DELETE /PublishProfiles/{id}.
LanguagePack (Languages)
Installed language packs.
GET /Languages — List language packs. Param: showall (boolean).
Standard CRUD: POST /Languages, GET /Languages/{id}, DELETE /Languages/{id}.
LanguagePackTranslationsCustom (Translation)
Custom translation overrides.
| Method | Path | Description |
|---|---|---|
GET | /Translation | List custom translations. |
POST | /Translation | Create or update translations. |
Distribution Lists & Contact Groups
DistributionLists
Email distribution list definitions.
Standard CRUD: GET /DistributionLists, POST /DistributionLists, GET /DistributionLists/{id}, DELETE /DistributionLists/{id}.
DistributionListsLog
Audit log of distribution list activity.
Standard CRUD: GET /DistributionListsLog, POST /DistributionListsLog, GET /DistributionListsLog/{id}, DELETE /DistributionListsLog/{id}.
contactgroup
Contact groups.
Standard CRUD: GET /Contactgroup, POST /Contactgroup, GET /Contactgroup/{id}, DELETE /Contactgroup/{id}.
contactgroupcontacts
Members within contact groups.
Standard CRUD: GET /Contactgroupcontact, POST /Contactgroupcontact, GET /Contactgroupcontact/{id}, DELETE /Contactgroupcontact/{id}.
addressbook
Address book entries.
Standard CRUD: GET /Addressbook, POST /Addressbook, GET /Addressbook/{id}, DELETE /Addressbook/{id}.
Addresses & Qualifications
AddressStore
Physical address records linked to users, sites, or tickets.
GET /Address — List addresses. Key params: user_id, site_id, type_id, postcode (string), count (integer). Additional ticket-context filters: openedafter (bool — tickets opened in last 30 days), onholdonly (bool — on SLA hold), overrideclientid, overridesiteid, overrideuserid (integers).
Standard CRUD: POST /Address, GET /Address/{id}, DELETE /Address/{id}.
Qualification
Agent/contact qualifications and certifications.
GET /Qualification — List qualifications. Param: includecriteriainfo (boolean).
Standard CRUD: POST /Qualification, GET /Qualification/{id}, DELETE /Qualification/{id}.
Tags & Todo
Tag (Tags)
Standard CRUD: GET /Tags, POST /Tags, GET /Tags/{id}, DELETE /Tags/{id}.
ToDoGroup
Groups for to-do items.
Standard CRUD: GET /ToDoGroup, POST /ToDoGroup, GET /ToDoGroup/{id}, DELETE /ToDoGroup/{id}.
External Links
ExternalLink
Links between Halo records and third-party system records.
GET /ExternalLink — List external links. Key params: halo_id (integer), module_id (integer), table_id (integer), details_id (integer), third_party_id (string), third_party_desc (string), third_party_secondary_id (string), third_party_type (string), module_list (string), search (string). Supports pagination.
| Method | Path | Description |
|---|---|---|
POST | /ExternalLink | Create or update an external link. |
GET | /ExternalLink/{id} | Get single external link. |
DELETE | /ExternalLink/{id} | Delete an external link. |
POST | /ExternalLink/Generate | Generate external links automatically. |
Instance & Module Configuration
Instance
HaloPSA instance configuration records.
GET /Instance — List instances. Param: comparewith (string — compare against a reference instance).
| Method | Path | Description |
|---|---|---|
POST | /Instance | Create or update instance config. |
GET | /Instance/{id} | Get single instance config. |
InstanceInfo
GET /InstanceInfo — Get instance info/metadata (no parameters).
ModuleSetup (Features)
Module/feature enable/disable configuration.
GET /Features — List module setups. Params: isconfig (boolean), showdisabled (boolean), showenabled (boolean).
| Method | Path | Description |
|---|---|---|
POST | /Features | Enable or configure a module. |
GET | /Features/{id} | Get single module setup. |
Tenant
Multi-tenant configuration.
| Method | Path | Description |
|---|---|---|
GET | /Tenant | List tenants. |
POST | /Tenant | Create or update a tenant. |
ObjectMappingProfile
GET /ObjectMappingProfile — List object mapping profiles (no parameters).
Health & System Status
Health
| Method | Path | Description |
|---|---|---|
GET | /Health | System health check — returns overall health status. |
GET | /Health/Hashing | Hashing/cryptography health check. |
ClientCache
GET /ClientCache — Retrieve client cache information (no parameters).
Halo Server & Device Management
NHServerConfig
HaloServer service configuration.
Standard CRUD: GET /Nhserverconfig, POST /Nhserverconfig, GET /Nhserverconfig/{id}, DELETE /Nhserverconfig/{id}.
NHD_DeviceInfo (HaloDeviceInfo)
Enrolled device registrations for HaloServer.
| Method | Path | Description |
|---|---|---|
GET | /HaloDeviceInfo/{id} | Get device info for a device ID (string). |
DELETE | /HaloDeviceInfo/{id} | Remove a device registration. |
POST | /HaloDeviceInfo | Register a new device. |
NHD_Identity_Application (Application)
OAuth application registrations.
| Method | Path | Description |
|---|---|---|
GET | /Application | List registered applications. |
POST | /Application | Register a new application. |
GET | /Application/{id} | Get single application (string ID). |
DELETE | /Application/{id} | Delete an application registration. |
POST | /Application/federatedcredentials | Add federated credentials to an application. |
NHD_Roles (Roles)
Role definitions for Halo identity.
Standard CRUD: GET /Roles (params: access_control_level, agentid, isconfig), POST /Roles, GET /Roles/{id}, DELETE /Roles/{id}.
Third-Party Integrations
AWS / AWSDetails
| Method | Path | Description |
|---|---|---|
GET | /AWS/Get | Retrieve AWS integration data. |
GET | /AWSDetails | List AWS integration detail records. |
POST | /AWSDetails | Create or update AWS details. |
GET | /AWSDetails/{id} | Get single AWS detail record. |
DELETE | /AWSDetails/{id} | Delete an AWS detail record. |
AzureDelta
Azure change tracking (delta sync) configurations.
Standard CRUD: GET /AzureDelta, POST /AzureDelta, GET /AzureDelta/{id}, DELETE /AzureDelta/{id}.
AzureTranslate
| Method | Path | Description |
|---|---|---|
GET | /AzureTranslate/CustomTranslate | Retrieve custom translation results from Azure. |
POST | /AzureTranslate/LanguagePackTranslate | Trigger Azure-powered language pack translation. |
AdobeAcrobatDetails
Adobe Acrobat Sign integration configuration.
Standard CRUD: GET /AdobeAcrobatDetails, POST /AdobeAcrobatDetails, GET /AdobeAcrobatDetails/{id}, DELETE /AdobeAcrobatDetails/{id}.
VMWorkspaceDetails
VMware Workspace ONE integration configuration.
Standard CRUD: GET /VMWorkspaceDetails, POST /VMWorkspaceDetails, GET /VMWorkspaceDetails/{id}, DELETE /VMWorkspaceDetails/{id}.
GWorkspaceDetails
Google Workspace integration configuration.
Standard CRUD: GET /GWorkspaceDetails, POST /GWorkspaceDetails, GET /GWorkspaceDetails/{id}, DELETE /GWorkspaceDetails/{id}.
ForethoughtDetails
Forethought AI integration configuration.
Standard CRUD: GET /ForethoughtDetails, POST /ForethoughtDetails, GET /ForethoughtDetails/{id}, DELETE /ForethoughtDetails/{id}.
PagerDutyMapping
GET /pagerdutymapping — List PagerDuty service mappings. Param: service_id (integer).
LapSafe
LapSafe device management integration.
| Method | Path | Description |
|---|---|---|
GET | /LapSafe/Get | Retrieve LapSafe data. |
GET | /LapSafe/Cancel | Cancel a LapSafe operation. |
GET | /LapSafe/Complete | Mark a LapSafe operation as complete. |
Hopewiser
GET /Hopewiser/Get — Retrieve address lookup data from Hopewiser.
Alemba
GET /Alemba/Get — Retrieve data from the Alemba integration.
Zendesk
GET /Zendesk/Get — Retrieve data from the Zendesk integration.
Vorboss
GET /Vorboss/Get — Retrieve data from the Vorboss integration.
ATT
GET /ATT/PriceAndAvailability — Query AT&T price and availability data.
ExampleIntegration
GET /Example/Get — Example/stub integration endpoint (development reference).
Miscellaneous Configuration
CustomTable
Custom relational table definitions (for custom field data storage).
GET /CustomTable — List custom tables. Params: access_control_level, customonly (boolean), isconfig (boolean), iswebhookmapping (boolean), systemonly (boolean), usage (string).
Standard CRUD: POST /CustomTable, GET /CustomTable/{id}, DELETE /CustomTable/{id}.
Diagnostic / Test Endpoints
The following endpoints are diagnostic stubs (no documented parameters):
| Endpoint | Description |
|---|---|
GET /Test1 | Test endpoint 1. |
GET /Test3 | Test endpoint 3. |
GET /Test4 | Test endpoint 4. |
GET /TestError | Test error response endpoint. |