Integration Framework Endpoints (cont.)

IntegrationDelta (continued)

DELETE /IntegrationDelta/{id}

Delete a delta record.

Parameter	Type	Description
id	integer (path, required)	Delta record ID

---

IntegrationError

Logs errors encountered during integration sync operations.

GET /IntegrationError

List integration errors. Returns multiple IntegrationError records.

Parameter	Type	Description
count	integer	Max number to return
detail_id	integer	Filter by integration detail ID
module_id	integer	Filter by integration module ID
order – order5	string	Sort fields (up to 5)
orderdesc – orderdesc5	boolean	Sort descending for each order field
page_no	integer	Page number
page_size	integer	Records per page
pageinate	boolean	Enable pagination

POST /IntegrationError

Create integration error records.

Request body: Array of IntegrationError objects.

GET /IntegrationError/{id}

Get a single integration error.

Parameter	Type	Description
id	integer (path, required)	Error record ID
includedetails	boolean	Include full detail fields

DELETE /IntegrationError/{id}

Delete an integration error record.

Parameter	Type	Description
id	integer (path, required)	Error record ID

---

IntegrationExport

Manages queued export jobs — records staged for export from HaloPSA to an integration.

GET /IntegrationExport

List pending or completed export records.

Parameter	Type	Description
moduleId	integer	Filter by integration module
readyForImport	boolean	Filter to records ready to import into the remote system

POST /IntegrationExport

Queue export records.

Request body: Array of IntegrationExport objects.

DELETE /IntegrationExport/{id}

Delete an export record.

Parameter	Type	Description
id	integer (path, required)	Export record ID

---

IntegrationFieldData

Stores field-level data for integration records (raw mapped field values).

GET /IntegrationFieldData

List all integration field data records.

No query parameters documented.

POST /IntegrationFieldData

Create or update field data records.

Request body: Array of IntegrationFieldData objects.

GET /IntegrationFieldData/{id}

Get a single field data record.

Parameter	Type	Description
id	integer (path, required)	Field data record ID

DELETE /IntegrationFieldData/{id}

Delete a field data record.

Parameter	Type	Description
id	integer (path, required)	Field data record ID

---

IntegrationFieldMapping

Manages field-level mappings between HaloPSA fields and third-party integration fields.

GET /IntegrationFieldMapping

List integration field mappings.

Parameter	Type	Description
msid	string	Integration module/source ID
product_id	integer	Filter by product
subtypeid	string	Sub-type filter
syncfields	boolean	Return only sync-enabled fields
typeid	string	Type filter
xmvalue	string	External mapping value filter

---

IntegrationLookUp

Stores lookup/mapping tables used during integration data sync.

GET /IntegrationLookUp

List all lookup entries.

No query parameters documented.

POST /IntegrationLookUp

Create or update lookup entries.

Request body: Array of IntegrationLookUp objects.

---

IntegrationRequest

Logs inbound and outbound API requests made during integration sync. Useful for diagnostics and debugging.

GET /IntegrationRequest

List integration request logs.

Parameter	Type	Description
count	integer	Max records to return
detail_id	integer	Filter by integration detail
inbound_only	boolean	Return only inbound requests
outbound_only	boolean	Return only outbound requests
module_id	integer	Filter by module
order – order5	string	Sort fields
orderdesc – orderdesc5	boolean	Sort descending
page_no	integer	Page number
page_size	integer	Page size
pageinate	boolean	Enable pagination

POST /IntegrationRequest

Create request log entries.

Request body: Array of IntegrationRequest objects.

GET /IntegrationRequest/{id}

Get a single request log entry.

Parameter	Type	Description
id	integer (path, required)	Request log ID
includedetails	boolean	Include full details

DELETE /IntegrationRequest/{id}

Delete a request log entry.

Parameter	Type	Description
id	integer (path, required)	Request log ID

---

IntegrationRunbookVariableGroup

Manages variable groups for integration runbooks (automation playbooks).

GET /IntegrationRunbookVariableGroup

List all runbook variable groups.

Parameter	Type	Description
exclude_method_id	boolean	Exclude method ID from results
one_runbook_id	string	Filter to a specific runbook

GET /IntegrationRunbookVariableGroup/{id}

Get a single runbook variable group.

Parameter	Type	Description
id	string (path, required)	Variable group ID
exclude_method_id	integer	Exclude a specific method ID
method_ids	string	Comma-separated list of method IDs to include

---

IntegrationSiteMapping

Maps third-party customer/site IDs to HaloPSA sites (clients).

GET /IntegrationSiteMapping

List site mappings.

Parameter	Type	Description
get_active_only	boolean	Return only active mappings
msid	integer	Filter by integration module source ID
third_party_client_id	string	Filter by third-party client ID

---

IntegratorLog

Stores log entries produced by the HaloPSA integrator engine during sync runs.

GET /IntegratorLog

List integrator log entries.

Parameter	Type	Description
module_id	integer	Filter by integration module
page_no	integer	Page number
page_size	integer	Page size
pageinate	boolean	Enable pagination

---

IntegratorSchedule

Manages the scheduled sync times for integration modules.

GET /IntegratorSchedule

List integration sync schedules.

Parameter	Type	Description
page_no	integer	Page number
page_size	integer	Page size
pageinate	boolean	Enable pagination

---

IntegratorTrace

Low-level trace data for integration sync operations (detailed request/response tracing).

GET /IntegratorTrace

List all trace records.

No query parameters documented.

GET /IntegratorTrace/{id}

Get a single trace record.

Parameter	Type	Description
id	integer (path, required)	Trace record ID

---

ConnectedInstance

Manages connected HaloPSA instances (for multi-instance or parent-child Halo setups).

GET /ConnectedInstance

List all connected instances.

No query parameters documented.

POST /ConnectedInstance

Create or update connected instance records.

Request body: Array of ConnectedInstance objects.

GET /ConnectedInstance/{id}

Get a single connected instance.

Parameter	Type	Description
id	integer (path, required)	Connected instance ID
includedetails	boolean	Include full configuration details

DELETE /ConnectedInstance/{id}

Delete a connected instance.

Parameter	Type	Description
id	integer (path, required)	Connected instance ID