Project Endpoints
Projects
Projects
GET /Projects
Summary: List of Faults (Projects)
Description: Returns multiple project records. Requires authentication.
Query Parameters:
| Name | Type | Description |
|---|---|---|
advanced_search | string | Advanced search string |
agent | string | (array of int) Returns tickets based on Agent ID's in the array |
agent_id | integer | Filters by the specified agent |
alerttype | string | Includes fninjaalertid field in the response — use 'ninjarmm' |
asset_id | integer | Filters by the specified asset |
awaitinginput | string | Filter on awaiting input status |
billableonly | boolean | Return only billable tickets |
billing_date | string | Filter on billing date |
billing_type | string | Filter on billing type |
billingcontractid | integer | Filter by billing contract ID |
calendar_enddate | string | Actions occurred before this date (calendar search) |
calendar_startdate | string | Actions occurred after this date (calendar search) |
category_1 | string | (array of int) Filter by category 1 ID's |
category_2 | string | (array of int) Filter by category 2 ID's |
category_3 | string | (array of int) Filter by category 3 ID's |
category_4 | string | (array of int) Filter by category 4 ID's |
cf_display_values_only | boolean | Use performant custom field query; returns display values only (not IDs), limited to 1000 chars |
checkmyticketsonly | boolean | Return only current user's tickets |
client_id | integer | Filters by the specified client |
client_ids | string | (array of int) Filter by client ID's |
client_ref | string | Filter by client reference |
closed_only | boolean | Returns only closed tickets |
columns_id | integer | The column profile ID |
contract_id | integer | Filters by the specified contract |
contract_period | integer | Filters by the specified contract period |
count | integer | Number of tickets to return |
datesearch | string | Date field to search against — e.g. 'dateoccured' (opened), 'datecleared' (closed) |
default_columns | boolean | Include only default columns in response |
deleted | boolean | Include deleted tickets |
domain | string | Filter by ticket area — 'reqs' = not projects/opportunities, 'opps' = opportunities, 'prjs' = projects |
enddate | string | End date for use with datesearch |
enddatetime | boolean | Include project end date and time details |
excludeslacalcs | boolean | Exclude SLA calculation details |
excludethese | string | (array of int) Exclude specific fault ID's |
excludetickettypeallowall | boolean | Exclude ticket type allow-all details |
extraportalfilter | string | 'MyTicketsOnly' or 'MyClientTickets' |
facebook_id | string | Filter by Facebook ID |
fetchgrandchildren | boolean | Include grandchild tickets |
flagged | string | (array of int) Filter by flagged ticket ID's |
followedandagents | string | (array of int) Filter by agent and follower ID's |
ignoremilestonerestriction | boolean | Ignore milestone restrictions |
includeaccountmanager | boolean | Include account manager details |
includeagent | boolean | Include agent details |
includeallopen | boolean | Include all open tickets |
includeappointmentid | boolean | Include appointment ID |
includeapproval | string | (array of int) Filter on approval — 1 = approval, 0 = not approval |
includeassetkeyfield | boolean | Include asset key field |
includeassettype | boolean | Include asset type details |
includebreached | string | (array of int) Filter by breached ticket ID's |
includebudgettype | boolean | Include budget type details |
includechildids | boolean | Include child ticket IDs |
includechildread | boolean | Include child tickets read status |
includechildren | string | (array of int) Filter — 0 = no children and not a child, 1 = has children, 2 = is a child |
includeclosed | string | (array of int) Filter — 1 = closed, 0 = not closed |
includecolumns | boolean | Include column details |
includecompleted | boolean | Include completed tickets |
includecontract | boolean | Include contract details |
includefirstname | boolean | Include user first name |
include_custom_fields | string | Comma-separated list of custom field IDs to include |
includefollowedonly | string | (array of int) Filter by follower ID's |
includehold | string | (array of int) Filter by on-hold ticket ID's |
includeinactivetechs | string | (array of int) Filter by inactive tech ID's |
includeinactiveusers | string | (array of int) Filter — 1 = inactive, 0 = active |
includeitilname | boolean | Include ITIL name |
includelastaction | boolean | Include last action (only returned when one ticket is in result) |
includelastincomingemail | boolean | Include last incoming email details |
includelastname | boolean | Include user last name |
includelastnote | boolean | Include last note details |
includelocked | boolean | Include locked tickets |
includemailbox | boolean | Include email box details |
includemyuseronly | string | (array of int) Filter to current user's tickets |
includenextactivitydate | boolean | Include next activity date |
includenextappointmenttype | boolean | Include next appointment type |
includeprojects | string | (array of int) Filter — 1 = opportunities not projects, 2 = projects not opportunities, 0 = neither |
includeread | string | (array of int) Filter by read ticket ID's |
includerelatedservices | boolean | Include related services |
includerelease1 | boolean | Include release 1 details |
includerelease2 | boolean | Include release 2 details |
includerelease3 | boolean | Include release 3 details |
includeservicecategory | boolean | Include service category |
includeslaactiondate | boolean | Include SLA action date |
includeslatimer | boolean | Include SLA timer |
includestatus | boolean | Include status details |
includesubmittedonly | string | (array of int) Filter by agent submitted ID's |
includesupplier | boolean | Include supplier details |
includetickettype | boolean | Include ticket type details |
includetimetaken | boolean | Include time taken |
includetoplevel | boolean | Include top level details |
includeviewing | boolean | Include tickets currently being viewed |
includeworkflowstage | boolean | Include workflow stage details |
includeworkflowstagenumber | boolean | Include workflow stage number |
inlcludeopenchildcount | boolean | Include open child ticket count |
ismilestone | boolean | Filter to milestone tickets |
isorion | boolean | Include Orion integration details |
isquicktimesearch | boolean | Return only quick-time tickets |
isscom | boolean | Include SCOM integration details |
isteams | boolean | Return only Teams tickets |
iszapier | boolean | Return a single ticket based on Zapier permissions |
itil_requesttype | string | (array of int) Filter by ITIL request type ID's |
itil_requesttype_id | integer | Filter by ITIL ticket type |
kanbanviewontheagentapp | boolean | Include agent app kanban view |
kanbanviewontheportal | boolean | Include portal kanban view |
lastupdatefromdate | boolean | Filter by last update from date |
lastupdatetodate | boolean | Filter by last update to date |
list_id | integer | Filter by specified list |
milestone_id | integer | Filter by milestone ID |
mine | boolean | Include only tickets belonging to the current user |
nochargeonly | boolean | Return only no-charge tickets |
notime | boolean | Exclude time data |
onlytime | boolean | Return only time data |
open_only | boolean | Return only open tickets |
order | string | Field name to order by (first) |
order2 | string | Field name to order by (second) |
order3 | string | Field name to order by (third) |
order4 | string | Field name to order by (fourth) |
order5 | string | Field name to order by (fifth) |
orderdesc | boolean | Order descending on first sort field |
orderdesc2 | boolean | Order descending on second sort field |
orderdesc3 | boolean | Order descending on third sort field |
orderdesc4 | boolean | Order descending on fourth sort field |
orderdesc5 | boolean | Order descending on fifth sort field |
orion_type | integer | Filter by Orion type |
page_no | integer | Page number for pagination |
page_size | integer | Page size for pagination (max 100) |
pageinate | boolean | Enable pagination |
parent_id | integer | Filter by specified parent ticket |
pending_review | boolean | Filter on pending review |
per_action | boolean | Calculate billing per action |
priority | string | (array of int) Filter by priority ID's |
product | string | (array of int) Filter by product ID's |
project_ids | string | Filter by specific project ID's |
ready_for_invoicing | boolean | Filter on ready-for-invoicing |
related_id | integer | Filter by related ticket ID |
release_id | integer | Filter by release ID |
requesttype | string | (array of int) Filter by request type ID's |
requesttype_id | integer | Filter by request type |
requesttypegroup | string | (array of int) Filter by request type group ID's |
search | string | Filter by search string |
search_details | string | Filter by ticket details content |
search_id | string | Filter by ticket ID matching the search |
search_inventory_number | string | Filter by asset tag |
search_oppcompanyname | string | Filter by opportunity company name |
search_oppcontactname | string | Filter by opportunity contact name |
search_oppemailaddress | string | Filter by opportunity email address |
search_release1 | string | Filter by release 1 name |
search_release2 | string | Filter by release 2 name |
search_release3 | string | Filter by release 3 name |
search_releasenote | string | Filter by release note content |
search_reportedby | string | Filter by reported-by field |
search_summary | string | Filter by ticket summary |
search_supplier_reference | string | Filter by supplier reference |
search_user_name | string | Filter by user name |
search_version | string | Filter by software version |
searchactions | boolean | Search within actions when using search |
searchthisticketid | integer | Filter by specific ticket ID |
service_id | integer | Filter by service |
showonroadmap | string | (array of int) Filter roadmap visibility — 1 = visible, 0 = not visible |
third_party_id | integer | Filter by third-party ID |
third_party_id_string | string | Filter by third-party ID string |
site_id | integer | Filter by site |
sitepostcode | boolean | Include site postcode details |
sla | string | (array of int) Filter by SLA ID's |
sprint_for_tickettype_id | integer | Filter by sprint ticket type ID |
sprints | boolean | Return only sprint tickets |
startandendset | boolean | Filter to tickets with a project start and end date set |
startdate | string | Start date for use with datesearch |
startdatetime | boolean | Include project start date and time details |
status | string | (array of int) Filter by status ID's |
status_id | integer | Filter by status |
submittedandagents | string | (array of int) Filter by agent and agent-submitted ID's |
supplier_id | integer | Filter by supplier |
supplier_status | string | (array of int) Filter by supplier status ID's |
team | string | (array of int) Filter by team ID's |
team_name | string | Include team name in response |
ticketarea_id | integer | Return tickets in this ticket area |
ticketcontract_id | integer | Filter by ticket contract |
ticketidonly | boolean | Return only ID fields (Ticket ID, SLA ID, Status ID, Client ID/Name, lastincomingemail date) — not compatible with pagination |
ticketids | string | Return only the specified ticket ID's |
toplevel_id | integer | Filter by top-level ID |
unlinked_only | boolean | Return only unlinked tickets |
user_id | integer | Filter by user |
username | string | Filter by username |
utcoffset | number (double) | Adds an offset to UTC dates |
view_id | integer | The filter profile ID to filter by |
withattachments | boolean | Return only tickets with one or more attachments |
filetype_filter | string | Filter tickets containing an attachment with the specified file type |
Response: 200 OK — Faults_View schema
POST /Projects
Summary: Create project(s)
Description: Creates one or more project records.
Request Body: Array of Faults objects (application/json)
Response: 201 Created — Faults schema
GET /Projects/{id}
Summary: Get one project
Description: Returns a single project record by ID. Requires authentication.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
id | integer (int32) | Yes | Project/ticket ID |
Query Parameters:
| Name | Type | Description |
|---|---|---|
amailentryid | string | Filter by mail entry ID |
assignedto | integer | Filter by assigned-to agent |
consignablelines | boolean | Include consignable lines |
debug | boolean | Include debug information |
dodatabaselookup | boolean | Force a database lookup |
email | string | Filter by email |
include_auditing | boolean | Include auditing data |
includeagent | boolean | Include agent details |
includechildids | boolean | Include child ticket IDs |
includedetails | boolean | Include extra objects |
includelastaction | boolean | Include last action |
includelastappointment | boolean | Include the last appointment |
includelinkedobjects | boolean | Include linked objects |
includenextappointment | boolean | Include the next appointment |
includeparentchangeinfo | boolean | Include parent change info |
includeparentsubject | boolean | Include parent subject |
includeseenby | boolean | Include seen-by details |
is_portal | boolean | Portal context flag |
isdetailscreen | boolean | Detail screen context flag |
ishalolink | boolean | HaloLink context flag |
ispreview | boolean | Preview context flag |
isteams | boolean | Return Teams tickets only |
nocache | boolean | Bypass cache |
subject | string | Filter by subject |
ticketidonly | boolean | Include only ID-related fields |
utcoffset | number (double) | Offset applied to UTC dates |
Response: 200 OK — Faults schema
DELETE /Projects/{id}
Summary: Delete one project
Description: Deletes a specific project record. Requires authentication.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
id | integer (int32) | Yes | Project/ticket ID |
Query Parameters:
| Name | Type | Description |
|---|---|---|
reason | string | Optional deletion reason |
Response: 200 OK
POST /Projects/View
Summary: Batch view/update projects
Description: Accepts an array of Faults objects for batch view operations.
Request Body: Array of Faults objects (application/json)
Response: 200 OK
ProjectSetupLines
POST /ProjectSetupLines
Summary: Create project setup lines
Description: Creates project setup line records used for templating project task structures.
Request Body: Array of ProjectSetupLines objects (application/json)
Response: 200 OK
Roadmap
GET /Roadmap
Summary: Get roadmap items
Description: Returns roadmap items. Requires authentication.
Query Parameters:
| Name | Type | Description |
|---|---|---|
halocrm | boolean | Filter for HaloCRM items |
haloitsm | boolean | Filter for HaloITSM items |
halopsa | boolean | Filter for HaloPSA items |
haloservicedesk | boolean | Filter for HaloServiceDesk items |
order | string | Field name to order by |
orderdesc | boolean | Order descending |
product_id | integer | Filter by product ID |
roadmapcolumnview | boolean | Use column view for roadmap |
Response: 200 OK