Workorder Category API (1.0.0)

Download OpenAPI specification:Download

API for managing workorder categories

Workorder Category

Workorder category management operations

Get all workorder categories

Retrieve a list of all workorder categories with optional filtering and pagination

Authorizations:

ApiKeyAuth

query Parameters

page	integer >= 1 Default: 1 Page number for pagination
per_page	integer [ 1 .. 100 ] Default: 25 Number of items per page
sort	string Sort field
company_namespace	Array of strings Company namespace for filtering
disabled	boolean Filter by disabled status
parent_category	string Filter by parent category ID
_id	Array of strings Filter by ID

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"success": true,
"data": [{"_id": "507f1f77bcf86cd799439011",
"name": "Maintenance",
"description": "General maintenance workorders",
"code": "MAINT",
"parent_category": "507f1f77bcf86cd799439012",
"color": "#FF5733",
"icon": "wrench",
"priority_level": 3,
"estimated_duration": 120,
"required_skills": ["electrical",
"plumbing"
],
"default_assignee": "507f1f77bcf86cd799439013",
"notification_settings": {"notify_on_creation": true,
"notify_on_completion": true,
"escalation_time": 0
},
"approval_required": false,
"custom_fields": [{"field_name": "string",
"field_type": "text",
"is_required": true,
"options": ["string"
]
}
],
"sla_settings": {"response_time": 0,
"resolution_time": 0,
"business_hours_only": true
},
"sort_order": 1,
"company_namespace": ["string"
],
"disabled": false,
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z",
"SVClient": 0,
"__v": 0
}
],
"paging": {"total": 0,
"page": 0,
"per_page": 0,
"pages": 0
}
}

Create a new workorder category

Authorizations:

ApiKeyAuth

Request Body schema: application/json

name required	string Category name
description	string Category description
code	string Category code for identification
parent_category	string Parent category ID for hierarchical structure
color	string Color code for visual identification
icon	string Icon identifier
priority_level	integer [ 1 .. 5 ] Default: 3 Default priority level for workorders in this category
estimated_duration	integer Estimated duration in minutes
required_skills	Array of strings Skills required for this category
default_assignee	string Default assignee for this category
	object
approval_required	boolean Default: false Whether approval is required for workorders in this category
	Array of objects
	object
sort_order	integer Default: 0 Sort order for display
company_namespace	Array of strings Company namespace
disabled	boolean Default: false Whether the category is disabled

Responses

Request samples

Payload

Content type

application/json

{"name": "Maintenance",
"description": "General maintenance workorders",
"code": "MAINT",
"parent_category": "string",
"color": "#FF5733",
"icon": "wrench",
"priority_level": 3,
"estimated_duration": 0,
"required_skills": ["string"
],
"default_assignee": "string",
"notification_settings": {"notify_on_creation": true,
"notify_on_completion": true,
"escalation_time": 0
},
"approval_required": false,
"custom_fields": [{"field_name": "string",
"field_type": "text",
"is_required": true,
"options": ["string"
]
}
],
"sla_settings": {"response_time": 0,
"resolution_time": 0,
"business_hours_only": true
},
"sort_order": 0,
"company_namespace": ["string"
],
"disabled": false
}

Response samples

Content type

application/json

{"success": true,
"data": {"_id": "507f1f77bcf86cd799439011",
"name": "Maintenance",
"description": "General maintenance workorders",
"code": "MAINT",
"parent_category": "507f1f77bcf86cd799439012",
"color": "#FF5733",
"icon": "wrench",
"priority_level": 3,
"estimated_duration": 120,
"required_skills": ["electrical",
"plumbing"
],
"default_assignee": "507f1f77bcf86cd799439013",
"notification_settings": {"notify_on_creation": true,
"notify_on_completion": true,
"escalation_time": 0
},
"approval_required": false,
"custom_fields": [{"field_name": "string",
"field_type": "text",
"is_required": true,
"options": ["string"
]
}
],
"sla_settings": {"response_time": 0,
"resolution_time": 0,
"business_hours_only": true
},
"sort_order": 1,
"company_namespace": ["string"
],
"disabled": false,
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z",
"SVClient": 0,
"__v": 0
}
}

Get workorder category by ID

Retrieve a specific workorder category by its ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Workorder category ID

Responses

Response samples

Content type

application/json

{"success": true,
"data": {"_id": "507f1f77bcf86cd799439011",
"name": "Maintenance",
"description": "General maintenance workorders",
"code": "MAINT",
"parent_category": "507f1f77bcf86cd799439012",
"color": "#FF5733",
"icon": "wrench",
"priority_level": 3,
"estimated_duration": 120,
"required_skills": ["electrical",
"plumbing"
],
"default_assignee": "507f1f77bcf86cd799439013",
"notification_settings": {"notify_on_creation": true,
"notify_on_completion": true,
"escalation_time": 0
},
"approval_required": false,
"custom_fields": [{"field_name": "string",
"field_type": "text",
"is_required": true,
"options": ["string"
]
}
],
"sla_settings": {"response_time": 0,
"resolution_time": 0,
"business_hours_only": true
},
"sort_order": 1,
"company_namespace": ["string"
],
"disabled": false,
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z",
"SVClient": 0,
"__v": 0
}
}

Update workorder category

Update an existing workorder category

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Workorder category ID

Request Body schema: application/json

name	string Category name
description	string Category description
code	string Category code for identification
parent_category	string Parent category ID for hierarchical structure
color	string Color code for visual identification
icon	string Icon identifier
priority_level	integer [ 1 .. 5 ] Default priority level for workorders in this category
estimated_duration	integer Estimated duration in minutes
required_skills	Array of strings Skills required for this category
default_assignee	string Default assignee for this category
	object
approval_required	boolean Whether approval is required for workorders in this category
	Array of objects
	object
sort_order	integer Sort order for display
company_namespace	Array of strings Company namespace
disabled	boolean Whether the category is disabled

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"code": "string",
"parent_category": "string",
"color": "string",
"icon": "string",
"priority_level": 1,
"estimated_duration": 0,
"required_skills": ["string"
],
"default_assignee": "string",
"notification_settings": {"notify_on_creation": true,
"notify_on_completion": true,
"escalation_time": 0
},
"approval_required": true,
"custom_fields": [{"field_name": "string",
"field_type": "text",
"is_required": true,
"options": ["string"
]
}
],
"sla_settings": {"response_time": 0,
"resolution_time": 0,
"business_hours_only": true
},
"sort_order": 0,
"company_namespace": ["string"
],
"disabled": true
}

Response samples

Content type

application/json

{"success": true,
"data": {"_id": "507f1f77bcf86cd799439011",
"name": "Maintenance",
"description": "General maintenance workorders",
"code": "MAINT",
"parent_category": "507f1f77bcf86cd799439012",
"color": "#FF5733",
"icon": "wrench",
"priority_level": 3,
"estimated_duration": 120,
"required_skills": ["electrical",
"plumbing"
],
"default_assignee": "507f1f77bcf86cd799439013",
"notification_settings": {"notify_on_creation": true,
"notify_on_completion": true,
"escalation_time": 0
},
"approval_required": false,
"custom_fields": [{"field_name": "string",
"field_type": "text",
"is_required": true,
"options": ["string"
]
}
],
"sla_settings": {"response_time": 0,
"resolution_time": 0,
"business_hours_only": true
},
"sort_order": 1,
"company_namespace": ["string"
],
"disabled": false,
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z",
"SVClient": 0,
"__v": 0
}
}

Delete workorder category

Delete a workorder category by ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Workorder category ID

Responses

Response samples

Content type

application/json

{"success": true
}

Bulk delete workorder categories

Delete multiple workorder categories by their IDs

Authorizations:

ApiKeyAuth

Request Body schema: application/json

ids

required

Array of strings

Array of workorder category IDs to delete

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
400
401
403
500

Content type

application/json

{"success": true
}

Get category hierarchy

Get workorder categories in hierarchical structure

Authorizations:

ApiKeyAuth

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"success": true,
"data": [{"_id": "string",
"name": "string",
"description": "string",
"code": "string",
"color": "string",
"icon": "string",
"children": [{ }
],
"workorder_count": 0
}
]
}