-
Notifications
You must be signed in to change notification settings - Fork 477
Expand file tree
/
Copy pathtools-manifest.json
More file actions
1711 lines (1711 loc) · 53.7 KB
/
Copy pathtools-manifest.json
File metadata and controls
1711 lines (1711 loc) · 53.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"api_name": "freshservice",
"base_url": "https://yourcompany.freshservice.com/api/v2",
"description": "Freshservice ITSM REST API v2 — tickets, changes, assets, users, and more.",
"mcp_ready": "full",
"http_transport": "standard",
"auth": {
"type": "api_key",
"header": "Authorization",
"format": "Basic {FRESHSERVICE_APIKEY}:{FRESHSERVICE_DOMAIN}",
"env_vars": [
"FRESHSERVICE_APIKEY",
"FRESHSERVICE_DOMAIN"
],
"env_var_specs": [
{
"name": "FRESHSERVICE_APIKEY",
"kind": "per_call",
"required": true,
"sensitive": true,
"description": "Personal Access Token from Freshservice Profile Settings → API Settings"
},
{
"name": "FRESHSERVICE_DOMAIN",
"kind": "per_call",
"required": true,
"sensitive": false,
"description": "Your Freshservice subdomain, e.g. acme.freshservice.com"
}
]
},
"required_headers": [],
"tools": [
{
"name": "agent-fields_list",
"description": "List the configured agent profile fields (the schema behind agent records). Returns an array of field definitions with id, label, name, type, choices, and required flag. Use this before creating or updating agents when you need to know which custom fields exist and their valid values.",
"method": "GET",
"path": "/agent_fields",
"params": []
},
{
"name": "agents_create",
"description": "Create an agent. Required: email, first_name. Optional: job_title, last_name, phone.",
"method": "POST",
"path": "/agents",
"params": [
{
"name": "email",
"type": "string",
"location": "body",
"description": "Email",
"required": true
},
{
"name": "first_name",
"type": "string",
"location": "body",
"description": "First name",
"required": true
},
{
"name": "job_title",
"type": "string",
"location": "body",
"description": "Job title"
},
{
"name": "last_name",
"type": "string",
"location": "body",
"description": "Last name"
},
{
"name": "phone",
"type": "string",
"location": "body",
"description": "Phone"
}
]
},
{
"name": "agents_delete",
"description": "Permanently delete an agent (destructive — the agent's record and group memberships are removed). Required: id (numeric agent ID). Returns 204 No Content on success. Prefer agents_deactivate if you only need to disable login; deletion cannot be undone.",
"method": "DELETE",
"path": "/agents/{id}",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
}
]
},
{
"name": "agents_get",
"description": "Fetch a single agent's full profile by numeric ID. Required: id. Returns the agent object with first_name, last_name, email, mobile_phone, work_phone, ticket_scope, group_ids, role_ids, occasional flag, signature, and active state. Use this when you already have an ID; use agents_list to search by attribute.",
"method": "GET",
"path": "/agents/{id}",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
}
]
},
{
"name": "agents_list",
"description": "List all agents in the workspace with pagination. Optional: query (Freshservice query DSL, e.g. 'email:'user@example.com''), page, per_page (max 100). Returns an array of agents with id, email, names, group_ids, role_ids, and active flag. Use changes_filter-style query for attribute search; agents_get when you already have an ID.",
"method": "GET",
"path": "/agents",
"params": [
{
"name": "query",
"type": "string",
"location": "query",
"description": "Query"
},
{
"name": "page",
"type": "int",
"location": "query",
"description": "Page"
},
{
"name": "per_page",
"type": "int",
"location": "query",
"description": "Per page"
}
]
},
{
"name": "agents_update",
"description": "Update agent. Required: id. Optional: email, first_name, last_name.",
"method": "PUT",
"path": "/agents/{id}",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
},
{
"name": "email",
"type": "string",
"location": "body",
"description": "Email"
},
{
"name": "first_name",
"type": "string",
"location": "body",
"description": "First name"
},
{
"name": "last_name",
"type": "string",
"location": "body",
"description": "Last name"
}
]
},
{
"name": "assets_create",
"description": "Create an asset. Required: asset_type_id, name. Optional: asset_tag, department_id, description (plus 2 more).",
"method": "POST",
"path": "/assets",
"params": [
{
"name": "asset_tag",
"type": "string",
"location": "body",
"description": "Asset tag"
},
{
"name": "asset_type_id",
"type": "int",
"location": "body",
"description": "Asset type id",
"required": true
},
{
"name": "department_id",
"type": "int",
"location": "body",
"description": "Department id"
},
{
"name": "description",
"type": "string",
"location": "body",
"description": "Description"
},
{
"name": "location_id",
"type": "int",
"location": "body",
"description": "Location id"
},
{
"name": "name",
"type": "string",
"location": "body",
"description": "Name",
"required": true
},
{
"name": "user_id",
"type": "int",
"location": "body",
"description": "User id"
}
]
},
{
"name": "assets_delete",
"description": "Soft-delete an asset by its display ID (destructive — the asset is hidden from default lists but can be restored within 30 days via assets_restore). Required: display_id (CMDB display identifier, not the internal numeric ID). Returns 204 No Content.",
"method": "DELETE",
"path": "/assets/{display_id}",
"params": [
{
"name": "display_id",
"type": "int",
"location": "path",
"description": "Display id",
"required": true
}
]
},
{
"name": "assets_get",
"description": "Fetch a single asset's full CMDB record by display ID. Required: display_id (e.g. '1', '42'). Returns the asset with name, asset_type_id, asset_tag, impact, usage_type, user_id, location_id, agent_id, and the full type_fields map (custom CMDB attributes vary by asset type).",
"method": "GET",
"path": "/assets/{display_id}",
"params": [
{
"name": "display_id",
"type": "int",
"location": "path",
"description": "Display id",
"required": true
}
]
},
{
"name": "assets_list",
"description": "List or search assets. Optional: search, filter, page (plus 1 more).",
"method": "GET",
"path": "/assets",
"params": [
{
"name": "search",
"type": "string",
"location": "query",
"description": "Search"
},
{
"name": "filter",
"type": "string",
"location": "query",
"description": "Filter"
},
{
"name": "page",
"type": "int",
"location": "query",
"description": "Page"
},
{
"name": "per_page",
"type": "int",
"location": "query",
"description": "Per page"
}
]
},
{
"name": "assets_update",
"description": "Update an asset. Required: display_id. Optional: description, name, user_id.",
"method": "PUT",
"path": "/assets/{display_id}",
"params": [
{
"name": "display_id",
"type": "int",
"location": "path",
"description": "Display id",
"required": true
},
{
"name": "description",
"type": "string",
"location": "body",
"description": "Description"
},
{
"name": "name",
"type": "string",
"location": "body",
"description": "Name"
},
{
"name": "user_id",
"type": "int",
"location": "body",
"description": "User id"
}
]
},
{
"name": "assets_components_list-asset",
"description": "List the hardware/software components attached to a single asset (CPU, memory, disks, installed apps depending on asset type). Required: display_id. Returns an array of component objects with id, component_type, and component_data. Use when triaging hardware tickets or building a software inventory report.",
"method": "GET",
"path": "/assets/{display_id}/components",
"params": [
{
"name": "display_id",
"type": "int",
"location": "path",
"description": "Display id",
"required": true
}
]
},
{
"name": "assets_contracts_list-asset",
"description": "List contracts (warranty, lease, maintenance) linked to a single asset. Required: display_id. Returns an array of contract summaries with id, name, contract_type, start_date, end_date, and status. Use to check warranty/support coverage before approving a repair or replacement ticket.",
"method": "GET",
"path": "/assets/{display_id}/contracts",
"params": [
{
"name": "display_id",
"type": "int",
"location": "path",
"description": "Display id",
"required": true
}
]
},
{
"name": "assets_requests_list-asset",
"description": "List service-request and incident tickets that reference a single asset. Required: display_id. Returns an array of ticket summaries with id, subject, status, priority, and created_at. Use to gather an asset's full ticket history when diagnosing a recurring hardware issue.",
"method": "GET",
"path": "/assets/{display_id}/requests",
"params": [
{
"name": "display_id",
"type": "int",
"location": "path",
"description": "Display id",
"required": true
}
]
},
{
"name": "assets_restore_asset",
"description": "Restore a previously soft-deleted asset back to active status. Required: display_id. Returns 204 No Content. Use within 30 days of assets_delete; after the retention window the asset is gone permanently.",
"method": "PUT",
"path": "/assets/{display_id}/restore",
"params": [
{
"name": "display_id",
"type": "int",
"location": "path",
"description": "Display id",
"required": true
}
]
},
{
"name": "canned-responses_get",
"description": "Fetch a single canned-response template by ID. Required: id. Returns the response with title, content (HTML or plain), content_html, visibility (folder_id), and group_ids who can use it. Use to preview a template before inserting it into a ticket reply.",
"method": "GET",
"path": "/canned_responses/{id}",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
}
]
},
{
"name": "canned-responses_list",
"description": "List all canned-response templates the calling agent can access. Returns an array of templates with id, title, content_summary, folder_id, and visibility. Use to surface reply suggestions when an agent is composing a ticket response.",
"method": "GET",
"path": "/canned_responses",
"params": []
},
{
"name": "change-form-fields_list",
"description": "List the configured change-record form fields (the schema behind change records, including any custom fields). Returns an array of field definitions with id, label, name, type, choices, required, position. Use before creating or updating changes to discover available custom fields.",
"method": "GET",
"path": "/change_form_fields",
"params": []
},
{
"name": "changes_create",
"description": "Create a change. Required: requester_id, subject. Optional: change_type, description, impact (plus 5 more).",
"method": "POST",
"path": "/changes",
"params": [
{
"name": "change_type",
"type": "int",
"location": "body",
"description": "1=Minor 2=Standard 3=Major 4=Emergency"
},
{
"name": "description",
"type": "string",
"location": "body",
"description": "Description"
},
{
"name": "impact",
"type": "int",
"location": "body",
"description": "1=Low 2=Medium 3=High"
},
{
"name": "planned_end_date",
"type": "string",
"location": "body",
"description": "Planned end date"
},
{
"name": "planned_start_date",
"type": "string",
"location": "body",
"description": "Planned start date"
},
{
"name": "priority",
"type": "int",
"location": "body",
"description": "1=Low 2=Medium 3=High 4=Urgent"
},
{
"name": "requester_id",
"type": "int",
"location": "body",
"description": "Requester id",
"required": true
},
{
"name": "risk",
"type": "int",
"location": "body",
"description": "1=Low 2=Medium 3=High 4=Very High"
},
{
"name": "status",
"type": "int",
"location": "body",
"description": "1=Open 2=Planning 3=Awaiting Approval 4=Pending Release 5=Pending Review 6=Closed"
},
{
"name": "subject",
"type": "string",
"location": "body",
"description": "Subject",
"required": true
}
]
},
{
"name": "changes_delete",
"description": "Permanently delete a change record (destructive — change history, notes, tasks, and approvals are removed). Required: id (numeric change ID). Returns 204 No Content. Cannot be undone; prefer setting status to cancelled if you only need to abort an unapproved change.",
"method": "DELETE",
"path": "/changes/{id}",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
}
]
},
{
"name": "changes_filter",
"description": "Search changes via the Freshservice query DSL (richer than list filters). Required: query (e.g. 'status:1 AND priority:\u003e2'). Returns an array of change summaries with id, subject, status, priority, planned_start_date, planned_end_date, requester_id, and assigned_agent_id. Prefer this over changes_list when you need attribute filters beyond pagination.",
"method": "GET",
"path": "/changes/filter",
"params": [
{
"name": "query",
"type": "string",
"location": "query",
"description": "Query",
"required": true
}
]
},
{
"name": "changes_get",
"description": "Fetch a single change record's full payload by ID. Required: id. Returns the change with subject, description_text, status, priority, impact, risk, change_type, planned_start_date, planned_end_date, requester_id, agent_id, group_id, department_id, approvers, and custom_fields. Use changes_list or changes_filter to discover IDs.",
"method": "GET",
"path": "/changes/{id}",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
}
]
},
{
"name": "changes_list",
"description": "List changes in the workspace, paginated. Optional: page, per_page (max 100). Returns an array of changes with id, subject, status, priority, planned dates, and assigned agent. For attribute filters (status, priority, date range) use changes_filter; this is the dumb pagination endpoint.",
"method": "GET",
"path": "/changes",
"params": [
{
"name": "page",
"type": "int",
"location": "query",
"description": "Page"
},
{
"name": "per_page",
"type": "int",
"location": "query",
"description": "Per page"
}
]
},
{
"name": "changes_update",
"description": "Update a change. Required: id. Optional: priority, status, subject.",
"method": "PUT",
"path": "/changes/{id}",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
},
{
"name": "priority",
"type": "int",
"location": "body",
"description": "Priority"
},
{
"name": "status",
"type": "int",
"location": "body",
"description": "Status"
},
{
"name": "subject",
"type": "string",
"location": "body",
"description": "Subject"
}
]
},
{
"name": "changes_notes_create-change",
"description": "Add an internal note (not a customer-visible reply) to a change record. Required: id (change ID) and body (note text, HTML allowed). Returns the new note with id, body, created_at, and user_id. Use to record approval discussion or post-implementation review notes; visible only to agents.",
"method": "POST",
"path": "/changes/{id}/notes",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
},
{
"name": "body",
"type": "string",
"location": "body",
"description": "Body",
"required": true
}
]
},
{
"name": "changes_notes_list-change",
"description": "List all internal notes attached to a single change. Required: id (change ID). Returns an array of notes with id, body, user_id, created_at. Use to read the change's discussion history before approving or rolling back.",
"method": "GET",
"path": "/changes/{id}/notes",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
}
]
},
{
"name": "changes_tasks_create-change",
"description": "Create change task. Required: id, title. Optional: description.",
"method": "POST",
"path": "/changes/{id}/tasks",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
},
{
"name": "description",
"type": "string",
"location": "body",
"description": "Description"
},
{
"name": "title",
"type": "string",
"location": "body",
"description": "Title",
"required": true
}
]
},
{
"name": "changes_tasks_delete-change",
"description": "Permanently remove a task line-item from a change's task list (destructive). Required: id (change ID) and task_id (task ID within that change). Returns 204 No Content. Useful when restructuring a change plan; cannot be undone.",
"method": "DELETE",
"path": "/changes/{id}/tasks/{task_id}",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
},
{
"name": "task_id",
"type": "int",
"location": "path",
"description": "Task id",
"required": true
}
]
},
{
"name": "changes_tasks_list-change",
"description": "List the implementation tasks attached to a single change record. Required: id (change ID). Returns an array of tasks with id, title, status, due_date, agent_id, and notify_before_seconds. Use to surface the change's runbook before approving or executing it.",
"method": "GET",
"path": "/changes/{id}/tasks",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
}
]
},
{
"name": "changes_tasks_update-change",
"description": "Update change task. Required: id, task_id. Optional: status, title.",
"method": "PUT",
"path": "/changes/{id}/tasks/{task_id}",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
},
{
"name": "task_id",
"type": "int",
"location": "path",
"description": "Task id",
"required": true
},
{
"name": "status",
"type": "int",
"location": "body",
"description": "Status"
},
{
"name": "title",
"type": "string",
"location": "body",
"description": "Title"
}
]
},
{
"name": "changes_time-entries_create-change-time-entry",
"description": "Create change time entry. Required: id, time_spent. Optional: agent_id, note.",
"method": "POST",
"path": "/changes/{id}/time_entries",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
},
{
"name": "agent_id",
"type": "int",
"location": "body",
"description": "Agent id"
},
{
"name": "note",
"type": "string",
"location": "body",
"description": "Note"
},
{
"name": "time_spent",
"type": "string",
"location": "body",
"description": "Format hh:mm",
"required": true
}
]
},
{
"name": "changes_time-entries_list-change",
"description": "List billable/non-billable time entries logged against a single change. Required: id (change ID). Returns an array of time entries with id, time_spent (HH:MM), executed_at, billable flag, note, and agent_id. Use for change-effort reporting or labor cost accounting.",
"method": "GET",
"path": "/changes/{id}/time_entries",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
}
]
},
{
"name": "contracts_list",
"description": "List vendor and warranty contracts in the workspace. Returns an array of contracts with id, name, contract_type, start_date, end_date, status (active/expired/about_to_expire), vendor_id, and cost. Use to surface expiring contracts in a renewal workflow.",
"method": "GET",
"path": "/contracts",
"params": []
},
{
"name": "departments_list",
"description": "List the organization's departments (used to scope tickets, agents, and assets). Returns an array of departments with id, name, description, head_user_id, and prime_user_id. Use when building a department dropdown or aggregating ticket metrics by department.",
"method": "GET",
"path": "/departments",
"params": []
},
{
"name": "groups_create",
"description": "Create a new agent group (a routing target for tickets, e.g. 'Network', 'Hardware'). Required: name. Optional: description, escalate_to (agent ID), unassigned_for (auto-escalate delay), business_hours_id, agent_ids. Returns the new group with id, created_at. Use during onboarding to mirror a new IT team in Freshservice.",
"method": "POST",
"path": "/groups",
"params": [
{
"name": "description",
"type": "string",
"location": "body",
"description": "Description"
},
{
"name": "name",
"type": "string",
"location": "body",
"description": "Name",
"required": true
}
]
},
{
"name": "groups_get",
"description": "Fetch a single agent group by ID. Required: id. Returns the group with name, description, agent_ids, escalate_to, unassigned_for, business_hours_id, and approval_required flag. Use to read current membership before adding/removing agents.",
"method": "GET",
"path": "/groups/{id}",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
}
]
},
{
"name": "groups_list",
"description": "List all agent groups in the workspace. Returns an array of groups with id, name, description, agent_ids count, and business_hours_id. Use to build a ticket-assignment picker or to audit group membership.",
"method": "GET",
"path": "/groups",
"params": []
},
{
"name": "groups_update",
"description": "Update agent group. Required: id. Optional: description, name.",
"method": "PUT",
"path": "/groups/{id}",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
},
{
"name": "description",
"type": "string",
"location": "body",
"description": "Description"
},
{
"name": "name",
"type": "string",
"location": "body",
"description": "Name"
}
]
},
{
"name": "locations_list",
"description": "List physical/logical locations defined in the workspace (sites, floors, rooms). Returns an array of locations with id, name, parent_location_id, contact_name, email, phone, and address fields. Use when filtering assets or tickets by site.",
"method": "GET",
"path": "/locations",
"params": []
},
{
"name": "products_create",
"description": "Register a new product (asset model template, e.g. 'MacBook Pro 16-inch 2024'). Required: name. Optional: description, asset_type_id, manufacturer, status (in_production/retired), mode_of_procurement. Returns the new product with id. Use during procurement onboarding before creating individual asset records of that model.",
"method": "POST",
"path": "/products",
"params": [
{
"name": "description",
"type": "string",
"location": "body",
"description": "Description"
},
{
"name": "name",
"type": "string",
"location": "body",
"description": "Name",
"required": true
}
]
},
{
"name": "products_get",
"description": "Fetch a single product (asset model) by ID. Required: id. Returns the product with name, description, asset_type_id, manufacturer, status, mode_of_procurement, created_at. Use to inspect a model before linking new assets to it.",
"method": "GET",
"path": "/products/{id}",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
}
]
},
{
"name": "products_list",
"description": "List all product (asset model) records. Returns an array of products with id, name, asset_type_id, manufacturer, status. Use to populate a model dropdown when bulk-creating assets.",
"method": "GET",
"path": "/products",
"params": []
},
{
"name": "products_update",
"description": "Update an existing product (asset model) record. Required: id. Optional: name, description, status, mode_of_procurement, manufacturer. Returns the updated product. Use to retire a model (status=retired) or correct manufacturer metadata.",
"method": "PUT",
"path": "/products/{id}",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
},
{
"name": "description",
"type": "string",
"location": "body",
"description": "Description"
},
{
"name": "name",
"type": "string",
"location": "body",
"description": "Name"
}
]
},
{
"name": "requester-fields_list",
"description": "List the configured requester (end-user) profile fields, including custom fields. Returns an array of field definitions with id, label, name, type, choices, required, position. Use before creating or updating requesters to discover the valid custom-field set.",
"method": "GET",
"path": "/requester_fields",
"params": []
},
{
"name": "requesters_create",
"description": "Create a requester. Required: first_name, primary_email. Optional: department_id, job_title, last_name (plus 2 more).",
"method": "POST",
"path": "/requesters",
"params": [
{
"name": "department_id",
"type": "int",
"location": "body",
"description": "Department id"
},
{
"name": "first_name",
"type": "string",
"location": "body",
"description": "First name",
"required": true
},
{
"name": "job_title",
"type": "string",
"location": "body",
"description": "Job title"
},
{
"name": "last_name",
"type": "string",
"location": "body",
"description": "Last name"
},
{
"name": "location_id",
"type": "int",
"location": "body",
"description": "Location id"
},
{
"name": "phone",
"type": "string",
"location": "body",
"description": "Phone"
},
{
"name": "primary_email",
"type": "string",
"location": "body",
"description": "Primary email",
"required": true
}
]
},
{
"name": "requesters_deactivate",
"description": "Deactivate a requester (end-user) so they can no longer log new tickets, without deleting their ticket history (destructive in the sense of revoking access). Required: id. Returns 204 No Content. Prefer over deletion when an employee leaves; their ticket history stays intact.",
"method": "DELETE",
"path": "/requesters/{id}",
"params": [
{
"name": "id",
"type": "int",
"location": "path",
"description": "Id",
"required": true
}
]
},
{
"name": "requesters_get",
"description": "Fetch a single requester (end-user) by ID. Required: id. Returns the requester with first_name, last_name, primary_email, secondary_emails, work_phone, mobile_phone_number, department_ids, location_id, reporting_manager_id, and active flag. Use to look up the person behind a ticket's requester_id.",
"method": "GET",
"path": "/requesters/{id}",
"params": [
{