System Config Endpoints

System Configuration & Administration

This section covers system-level configuration endpoints: custom fields, screen layouts, SLAs, service catalog, reporting, attachments, automation, integrations, and administrative utilities. Most resources follow standard CRUD patterns (List / Get / Create / Delete).

Common pagination parameters (available on most list endpoints): page_no (integer), page_size (integer), pageinate (boolean), count (integer), search (string), order / order2...order5 (string), orderdesc / orderdesc2...orderdesc5 (boolean).

---

Field & Custom Fields

Field

Custom field definitions used across ticket types and entities.

Method	Path	Description
GET	/Field	List fields. Filter by kind (string) and type_id (integer).
POST	/Field	Create or update fields. Body: array of Field objects.
GET	/Field/{id}	Get single field. Optional: includedetails (boolean), kind (string).
DELETE	/Field/{id}	Delete a field. Optional: kind (string).
POST	/Field/AddFieldToAll/{id}	Add a field to all entities of the given type.

FieldGroup

Groups of custom fields.

Method	Path	Description
GET	/FieldGroup	List field groups. Params: access_control_level (integer), includefields (boolean), isconfig (boolean).
POST	/FieldGroup	Create or update a field group.
GET	/FieldGroup/{id}	Get single field group. Optional: includedetails (boolean).
DELETE	/FieldGroup/{id}	Delete a field group.

FieldInfo

Metadata about available fields for use in custom field setup and dynamic lookups.

GET /FieldInfo — List field info records. Key parameters:

Parameter	Type	Description
access_control_level	integer	Filter by access control level.
domain	string	Restrict to a specific module domain.
fieldtype	integer	Filter by field type.
fieldtypemultiple	string	Comma-separated list of field types.
typeid	integer	Filter by entity type ID.
systemid	integer	Filter by system ID.
includevalues	boolean	Include lookup values in response.
includecategories	boolean	Include category info.
includedatefields	boolean	Include date-type fields.
includejirafields	boolean	Include Jira-mapped fields.
includeremotefields	boolean	Include fields from remote integrations.
isconfig	boolean	Configuration context filter.
iscustomfieldsetup	boolean	Filter to custom field setup context.
isapprovalstep	boolean	Filter to approval step fields.
excluderanges	boolean	Exclude range-type fields.
excludetables	boolean	Exclude table-type fields.
excludetableself	boolean	Exclude self-referencing table fields.
inputtype	integer	Filter by input type.
extratype	integer	Additional type filter.

POST /FieldInfo — Create or update field info.

GET /FieldInfo/{id} — Get single field info. Optional params: entityid, userid, includedetails, getlookupvalues, livecustomfields.

DELETE /FieldInfo/{id} — Delete field info.

HaloField

GET /HaloField — List Halo system fields (no parameters).

---

Screen Layout & UI Configuration

ScreenLayout

Defines field layout on entity screens.

Method	Path	Description
GET	/ScreenLayout	List layouts. Filter by typeid (integer).
POST	/ScreenLayout	Create or update a layout.
GET	/ScreenLayout/{id}	Get single layout. Optional: includedetails.
DELETE	/ScreenLayout/{id}	Delete a layout.

SetupTab / SetupTabGroup

Tab configuration for entity screens.

Method	Path	Description
GET	/SetupTab	List setup tabs.
POST	/SetupTab	Create or update a setup tab.
GET	/SetupTab/{id}	Get single setup tab.
GET	/SetupTabGroup	List setup tab groups.
GET	/SetupTabGroup/{id}	Get single setup tab group.

Tabname (Tabs)

Custom tab names for module screens.

Method	Path	Description
GET	/Tabs	List tabs. Filter by type (string) and typeid (integer).
POST	/Tabs	Create or update a tab.
GET	/Tabs/{id}	Get single tab.
DELETE	/Tabs/{id}	Delete a tab.

CustomButton

Action buttons added to entity screens.

Method	Path	Description
GET	/CustomButton	List buttons. Params: isbuttonsetup, ispermissionsetup, msid, typeid (all integer/boolean).
POST	/CustomButton	Create or update a button.
GET	/CustomButton/{id}	Get single button.
DELETE	/CustomButton/{id}	Delete a button.

CustomButtonAudit

POST /CustomButtonAudit — Log a custom button audit event.

Control

System-level control and cache management.

Method	Path	Description
GET	/Control	Get system control settings.
POST	/Control	Update system control settings.
POST	/Control/setup	Run setup procedures.
POST	/Control/ClearCache	Clear the system cache.
POST	/Control/UpdateEnc	Update encryption settings.
GET	/Control/Teams	Get teams via control endpoint.

---

Lookup & Priority

Lookup

Dropdown lookup lists used in fields across the system.

GET /Lookup — List lookup values. Key parameters:

Parameter	Type	Description
lookupid	integer	Filter by a specific lookup list ID.
use	integer	Filter by primary usage context.
use2	integer	Secondary usage context filter.
domain	string	Module domain filter.
client_id	integer	Filter to a client.
contract_id	integer	Filter to a contract.
ticket_id	integer	Filter to a ticket context.
outcome_id	integer	Filter to an outcome.
assettype_id	integer	Filter to an asset type.
country_code_id	integer	Filter by country code.
dbc_company_id	string	Filter by DBC company ID.
iscustomfield	boolean	Return custom field lookup values only.
istree	boolean	Return as tree structure.
exclude_nocharge	boolean	Exclude no-charge items.
exclude_nolinkedtypes	boolean	Exclude items not linked to types.
exclude_zero	boolean	Exclude zero-value items.
showallcodes	boolean	Show all codes including inactive.
ordervaluetype	integer	Control value ordering.
unameaprestriction	boolean	Apply username/AP restrictions.
access_control_level	integer	Filter by access level.
clientname	string	Filter by client name.

Method	Path	Description
POST	/Lookup	Create or update lookup values.
GET	/Lookup/{id}	Get single lookup. Optional: includedetails.
DELETE	/Lookup/{id}	Delete a lookup value.
POST	/Lookup/ClearCache	Clear the lookup cache.

Policy (Priority)

SLA priority policies.

Method	Path	Description
GET	/Priority	List priorities. Params: includedistinct (boolean), slaid (integer).
POST	/Priority	Create or update a priority.
GET	/Priority/{id}	Get single priority.
DELETE	/Priority/{id}	Delete a priority.

---

SLA & Service Management

SlaHead (SLA)

SLA head records — top-level SLA definitions.

Method	Path	Description
GET	/SLA	List SLAs. Params: access_control_level, isconfig (boolean), showpriorities (boolean), showworkdays (boolean).
POST	/SLA	Create or update an SLA.
GET	/SLA/{id}	Get single SLA. Optional: includedetails.
DELETE	/SLA/{id}	Delete an SLA.

ServiceCategory

Service catalog categories.

Method	Path	Description
GET	/ServiceCategory	List categories. Params: access_control_level, include_parent_name (boolean), itil_ticket_type (integer), user_id (integer).
POST	/ServiceCategory	Create or update a category.
GET	/ServiceCategory/{id}	Get single category. Optional: includedetails.
DELETE	/ServiceCategory/{id}	Delete a category.

ServiceAvailability

Service availability windows.

Method	Path	Description
GET	/ServiceAvailability	List availability records.
POST	/ServiceAvailability	Create or update availability.
GET	/ServiceAvailability/{id}	Get single availability record.
DELETE	/ServiceAvailability/{id}	Delete an availability record.

ServiceRestriction

GET /ServiceRestriction — List service restrictions. Params: client_id, service_category_id, service_id (all integer).

ServiceRequestDetails

GET /ServiceRequestDetails — List service request details. Params: service_id (integer), includedetails (boolean), exclude_urls (boolean).

GET /ServiceRequestDetails/{id} — Get single service request detail record.

ServStatus (Service Status)

Public service status board entries.

Method	Path	Description
GET	/ServiceStatus	List service status entries. Supports pagination. Filter by service_id (integer).
POST	/ServiceStatus	Create or update a status entry.
GET	/ServiceStatus/{id}	Get single status entry.
DELETE	/ServiceStatus/{id}	Delete a status entry.
GET	/ServiceStatus/Subscribe/{id}	Get subscription info for a status entry.
POST	/ServiceStatus/Subscribe	Subscribe to status notifications.

---

Teams & Organizational Structure

SectionDetail (Teams)

Team definitions and membership.

GET /Team — List teams. Key parameters:

Parameter	Type	Description
type	string	Domain filter: reqs (tickets), opps (opportunities), prjs (projects).
department_id	integer	Filter to teams in a specific department.
ids	string	Comma-separated list of team IDs to filter.
myteamsonly	boolean	Only return teams the current agent belongs to.
memberonly	boolean	Only return teams the current agent is a member of.
showall	boolean	Admin override — return all teams regardless of permissions.
can_edit_only	boolean	Filter to teams the agent has edit permission for.
chat_only	boolean	Filter to teams enabled for live chat.
includeagentsforteams	string	Comma-separated team names — include agents from these teams.
includedisabled	string	Include disabled teams.
includeenabled	string	Include enabled teams.
include_managers	boolean	Include manager details.
istree	boolean	Return as tree structure.
mydeps	boolean	Filter to current agent's departments.
orderbyseq	boolean	Order by sequence number.
outcome_id	integer	Filter by outcome.
showcounts	boolean	Include ticket counts per team.
ticketarea_id	integer	Ticket area filter (used with showcounts).
view_id	integer	View filter (used with showcounts).

Method	Path	Description
POST	/Team	Create or update a team.
GET	/Team/{id}	Get single team. Optional: includeagents, includedetails.
DELETE	/Team/{id}	Delete a team.
GET	/Team/Tree	Get teams as a hierarchical tree.

Tree (TopLevel / Departments)

Organizational hierarchy (departments / top-level nodes).

GET /TopLevel — List top-level org nodes. Key parameters:

Parameter	Type	Description
type	integer	Node type filter.
org_id	integer	Parent org node filter.
include_agents	boolean	Include agents in response.
include_managers	boolean	Include managers.
include_teams	boolean	Include child teams.
isorgchart	boolean	Return in org chart format.
agent_departments_only	boolean	Return only departments the current agent belongs to.
can_edit_only	boolean	Filter to nodes the agent can edit.
idonly	boolean	Return IDs only.
show_all	boolean	Show all nodes.
search	string	Text search.
Pagination	—	page_no, page_size, pageinate, count, order/orderdesc (×5).

Method	Path	Description
POST	/TopLevel	Create or update an org node.
GET	/TopLevel/{id}	Get single node. Optional: include_agents, include_teams, includedetails.
DELETE	/TopLevel/{id}	Delete an org node.

ResourceType

GET /ResourceType — List resource types (no parameters).

GET /ResourceType/{id} — Get single resource type.

---

Reporting & Analytics

AnalyzerProfile (Reports)

Saved reports and dashboard analytics.

GET /Report — List reports. Key parameters:

Parameter	Type	Description
type	integer	Report type filter.
reportgroup_id	integer	Filter by report group.
search	string	Text search.
chartonly	boolean	Return chart-type reports only.
includepublished	boolean	Include published reports.
agentrestriction	integer	Apply agent-level restriction.
clientname	string	Filter by client context.
Pagination	—	page_no, page_size, pageinate, count, order/orderdesc (×5).

GET /Report/{id} — Get single report. Optional params: loadreport, includedetails, reportingperiod, reportingperiodstartdate, reportingperiodenddate, dashboard_id, dashboard_published_id, client_id, clientname, invoice_id, getcompositetoken, report_access_token, dontloadsystemreport.

Method	Path	Description
POST	/Report	Create or update a report.
DELETE	/Report/{id}	Delete a report.
POST	/Report/print	Trigger report print.
POST	/Report/createpdf	Generate a PDF from a report.
POST	/Report/Bookmark	Bookmark a report.

Bookmark

Method	Path	Description
GET	/Bookmark/{id}	Get a bookmark by ID.
POST	/Bookmark	Create a bookmark.

SavedForecast

Standard CRUD for saved financial forecasts. Endpoints: GET /SavedForecast, POST /SavedForecast, GET /SavedForecast/{id}, DELETE /SavedForecast/{id}.

ForecastDetails

Integration details for forecast data sources. Standard CRUD: GET /ForecastDetails, POST /ForecastDetails, GET /ForecastDetails/{id}, DELETE /ForecastDetails/{id}.

---

Approval Workflow

ApprovalProcess

Top-level approval process definitions.

Method	Path	Description
GET	/ApprovalProcess	List approval processes. Param: access_control_level (integer).
POST	/ApprovalProcess	Create or update an approval process.
GET	/ApprovalProcess/{id}	Get single process. Optional: includedetails.
DELETE	/ApprovalProcess/{id}	Delete an approval process.

ApprovalProcessRule

Rules within approval processes.

Method	Path	Description
GET	/ApprovalProcessRule	List rules. Params: global (boolean), process_id (integer), step_id (integer).
POST	/ApprovalProcessRule	Create or update a rule.
GET	/ApprovalProcessRule/{id}	Get single rule.
DELETE	/ApprovalProcessRule/{id}	Delete a rule.

ApprovalStore

POST /ApprovalStore — Submit an approval store action (record an approval decision).

CriteriaGroup

GET /CriteriaGroup — List criteria groups (no parameters).

---

PowerShell & Automation

PowerShellScript

Stored PowerShell scripts for automation.

Method	Path	Description
GET	/PowerShellScript	List scripts. Params: clientidoverride (string), type (string).
POST	/PowerShellScript	Create or update a script.
GET	/PowerShellScript/{id}	Get single script. Optional: includedetails.
DELETE	/PowerShellScript/{id}	Delete a script.

PowerShellScriptCriteria

Criteria rules for triggering scripts.

Standard CRUD: GET /PowerShellScriptCriteria (param: script_id), POST /PowerShellScriptCriteria, GET /PowerShellScriptCriteria/{id}, DELETE /PowerShellScriptCriteria/{id}.

PowerShellScriptProcessing

Execution queue and log for PowerShell scripts.

GET /PowerShellScriptProcessing — List processing records. Key params: script_id (integer), ticket_id (integer), outstandingonly (boolean), includeparameters (boolean). Supports pagination.

Standard CRUD: POST /PowerShellScriptProcessing, GET /PowerShellScriptProcessing/{id}, DELETE /PowerShellScriptProcessing/{id}.

ScriptHeader (CallScript)

Call scripts (agent scripts/decision trees).

Standard CRUD: GET /CallScript, POST /CallScript, GET /CallScript/{id}, DELETE /CallScript/{id}.

VirtualAgent

Virtual agent (chatbot/AI assistant) configurations.

Standard CRUD: GET /VirtualAgent, POST /VirtualAgent, GET /VirtualAgent/{id}, DELETE /VirtualAgent/{id}.

AiSuggestion

AI suggestion rules and results.

Standard CRUD: GET /AISuggestion, POST /AISuggestion, GET /AISuggestion/{id}, DELETE /AISuggestion/{id}.

---

Background Tasks & Scheduling

BackgroundTask

GET /BackgroundTask/{id} — Get the status of a background task by ID.

TaskMonitorEvent

GET /TaskMonitorEvent — List task monitor events.

TaskSchedule

Method	Path	Description
GET	/TaskSchedule	List scheduled tasks.
POST	/TaskSchedule	Create or update a scheduled task.

TaskTrace

Method	Path	Description
GET	/TaskTrace	List task execution traces.
GET	/TaskTrace/{id}	Get single trace record.