Freshservice

Integração com a API do Freshservice, plataforma de ITSM da Freshworks.

Authentication

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions

This connector provides 483 actions:

Action	Purpose	Parameters
agent_groups/post_groups	Create a new agent group	data: { . name (string) . description (string) . escalate_to (integer) . unassigned_for (string) . business_hours_id (integer) . members (array) . observers (array) . leaders (array) . restricted (boolean) . approval_required (boolean) . ocs_schedule_id (integer) . workspace_id (integer) . agent_ids (array) } (object) required
agent_groups/get_groups	List all agent groups	page (integer) per_page (integer) workspace_id (integer)
agent_groups/get_groups_by_id	View an agent group by id	id (integer) required
agent_groups/put_groups_by_id	Update an agent group	id (integer) required data: { . name (string) . description (string) . escalate_to (integer) . unassigned_for (string) . business_hours_id (integer) . members (array) . observers (array) . leaders (array) . restricted (boolean) . approval_required (boolean) . ocs_schedule_id (integer) . workspace_id (integer) . agent_ids (array) } (object) required
agent_groups/delete_groups_by_id	Delete an agent group	id (integer) required
agent_roles/get_roles	List all agent roles	page (integer) per_page (integer) workspace_id (integer)
agent_roles/get_roles_by_id	View a role by id	id (integer) required
agents/post_agents	Create a new agent	data: { . first_name (string) . last_name (string) . occasional (boolean) . email (string) . job_title (string) . work_phone_number (string) . mobile_phone_number (string) . department_ids (array) . can_see_all_tickets_from_associated_departments (boolean) . reporting_manager_id (integer) . address (string) . time_zone (string) . time_format (string) . language (string) . location_id (integer) . background_information (string) . scoreboard_level_id (integer) . roles (array) . member_of (array) . observer_of (array) . signature (string) . workspace_ids (array) . external_id (string) . custom_fields (object) } (object) required
agents/get_agents	List or filter agents	email (string) mobile (string) phone (string) state (string) active (boolean) include (string) query (string) page (integer) per_page (integer)
agents/get_agents_by_id	View an agent by id	id (integer) required include (string)
agents/put_agents_by_id	Update an agent	id (integer) required data: { . first_name (string) . last_name (string) . occasional (boolean) . email (string) . job_title (string) . work_phone_number (string) . mobile_phone_number (string) . department_ids (array) . can_see_all_tickets_from_associated_departments (boolean) . reporting_manager_id (integer) . address (string) . time_zone (string) . time_format (string) . language (string) . location_id (integer) . background_information (string) . scoreboard_level_id (integer) . roles (array) . member_of (array) . observer_of (array) . signature (string) . workspace_ids (array) . external_id (string) . custom_fields (object) } (object) required
agents/delete_agents_by_id	Deactivate an agent	id (integer) required
agents/delete_agents_by_id_forget	Permanently delete an agent GDPR forget	id (integer) required
agents/put_agents_by_id_reactivate	Reactivate a deactivated agent	id (integer) required
agents/put_agents_by_id_convert_to_requester	Convert an agent into a requester contact	id (integer) required
agents/get_agents_fields	List all agent fields	page (integer) per_page (integer)
alerts/get_alerts	View multiple alerts using filters	page (integer) per_page (integer) query (string) state (string) severity (string)
alerts/get_alerts_by_id	View a single alert	id (string) required
alerts/delete_alerts_by_id	Delete an alert	id (string) required
alerts/get_alerts_by_id_logs	View all alert logs for a given alert	id (string) required page (integer) per_page (integer)
alerts/put_alerts_by_id_acknowledge	Acknowledge an alert	id (string) required data: { . note (string) } (object) required
alerts/put_alerts_by_id_resolve	Resolve an alert	id (string) required data: { . note (string) } (object) required
alerts/put_alerts_by_id_suppress	Suppress an alert	id (string) required data: { . note (string) . suppress_until (string) } (object) required
alerts/put_alerts_by_id_unsuppress	Unsuppress an alert	id (string) required
alerts/get_alerts_by_id_notes	List all notes for an alert	id (string) required
alerts/post_alerts_by_id_notes	Create a note on an alert	id (string) required data: { . body (string) } (object) required
alerts/get_alerts_by_id_notes_by_note_id	View a note on an alert	id (string) required note_id (integer) required
alerts/put_alerts_by_id_notes_by_note_id	Update a note on an alert	id (string) required note_id (integer) required data: { . body (string) } (object) required
alerts/delete_alerts_by_id_notes_by_note_id	Delete a note on an alert	id (string) required note_id (integer) required
announcements/post_announcements	Create an announcement	data: { . title (string) . body (string) . visible_from (string) . visible_till (string) . additional_emails (array) . visibility (string) } (object) required
announcements/get_announcements	List all announcements	page (integer) per_page (integer)
announcements/get_announcements_by_id	View an announcement	id (integer) required
announcements/put_announcements_by_id	Edit an announcement	id (integer) required data: { . title (string) . body (string) . visible_from (string) . visible_till (string) } (object) required
announcements/delete_announcements_by_id	Delete an announcement	id (integer) required
approvals/get_approvals	List all approvals	page (integer) per_page (integer) workspace_id (integer)
approvals/get_tickets_by_ticket_id_approvals	List all approvals for a ticket	ticket_id (integer) required page (integer) per_page (integer)
approvals/post_tickets_by_ticket_id_approvals	Request an approval for a service request ticket	ticket_id (integer) required data: { . approver_id (integer) . approval_type (integer) . email (string) } (object) required
approvals/get_tickets_by_ticket_id_approvals_by_approval_id	View an approval for a ticket	ticket_id (integer) required approval_id (integer) required
approvals/delete_tickets_by_ticket_id_approvals_by_approval_id	Cancel an approval on a ticket	ticket_id (integer) required approval_id (integer) required
approvals/post_tickets_by_ticket_id_approvals_by_approval_id_remind	Send a reminder for a ticket approval	ticket_id (integer) required approval_id (integer) required
approvals/get_tickets_by_ticket_id_approval_groups	List all approval groups on a ticket	ticket_id (integer) required page (integer) per_page (integer)
approvals/post_tickets_by_ticket_id_approval_groups	Create an approval group on a ticket	ticket_id (integer) required data: { . approvers (array) . approval_type (integer) . approval_percentage (integer) } (object) required
approvals/put_tickets_by_ticket_id_approval_groups_by_group_id	Update an approval group on a ticket	ticket_id (integer) required group_id (integer) required data: { . approvers (array) . approval_type (integer) . approval_percentage (integer) } (object) required
approvals/delete_tickets_by_ticket_id_approval_groups_by_group_id	Cancel an approval group on a ticket	ticket_id (integer) required group_id (integer) required
approvals/put_tickets_by_ticket_id_approval_chain_rules	Update the approval chain rule for a ticket	ticket_id (integer) required data: { . chain_type (integer) . chain_rule (string) . parallel (boolean) } (object) required
approvals/get_changes_by_change_id_approvals	List all approvals for a change	change_id (integer) required page (integer) per_page (integer)
approvals/get_changes_by_change_id_approvals_by_approval_id	View an approval for a change	change_id (integer) required approval_id (integer) required
approvals/delete_changes_by_change_id_approvals_by_approval_id	Cancel an approval on a change	change_id (integer) required approval_id (integer) required
approvals/post_changes_by_change_id_approvals_by_approval_id_send_reminder	Send a reminder for a change approval	change_id (integer) required approval_id (integer) required
approvals/get_changes_by_change_id_approval_groups	List all approval groups on a change	change_id (integer) required page (integer) per_page (integer)
approvals/post_changes_by_change_id_approval_groups	Create an approval group on a change	change_id (integer) required data: { . approvers (array) . approval_type (integer) . approval_percentage (integer) } (object) required
approvals/put_changes_by_change_id_approval_groups_by_group_id	Update an approval group on a change	change_id (integer) required group_id (integer) required data: { . approvers (array) . approval_type (integer) . approval_percentage (integer) } (object) required
approvals/delete_changes_by_change_id_approval_groups_by_group_id	Cancel an approval group on a change	change_id (integer) required group_id (integer) required
approvals/put_changes_by_change_id_approval_chain_rule	Update the approval chain rule for a change	change_id (integer) required data: { . chain_type (integer) . chain_rule (string) . parallel (boolean) } (object) required
asset_types/get_asset_types	List all asset types	page (integer) per_page (integer)
asset_types/post_asset_types	Create an asset type	data: { . name (string) . description (string) . parent_asset_type_id (integer) . workspace_id (integer) } (object) required
asset_types/get_asset_types_by_id	View a single asset type	id (integer) required
asset_types/put_asset_types_by_id	Update an asset type	id (integer) required data: { . name (string) . description (string) . parent_asset_type_id (integer) } (object) required
asset_types/delete_asset_types_by_id	Delete an asset type	id (integer) required
asset_types/get_asset_types_by_id_fields	List all fields for a given asset type	id (integer) required
assets/get_assets	List all assets	page (integer) per_page (integer) include (string) workspace_id (integer) filter (string)
assets/post_assets	Create a new asset	data: { . name (string) . description (string) . asset_type_id (integer) . asset_tag (string) . impact (string) . usage_type (string) . user_id (integer) . department_id (integer) . location_id (integer) . agent_id (integer) . group_id (integer) . assigned_on (string) . workspace_id (integer) . type_fields (object) } (object) required
assets/get_assets_by_id	View a single asset	id (integer) required include (string)
assets/put_assets_by_id	Update an asset	id (integer) required data: { . name (string) . description (string) . asset_type_id (integer) . asset_tag (string) . impact (string) . usage_type (string) . user_id (integer) . department_id (integer) . location_id (integer) . agent_id (integer) . group_id (integer) . assigned_on (string) . type_fields (object) } (object) required
assets/delete_assets_by_id	Delete an asset move to trash	id (integer) required
assets/put_assets_by_id_restore	Restore an asset from trash	id (integer) required
assets/delete_assets_by_id_delete_forever	Permanently delete an asset	id (integer) required
assets/put_assets_by_id_move_workspace	Move an asset to another workspace	id (integer) required data: { . workspace_id (integer) } (object) required
assets/get_assets_by_id_components	List all components of an asset	id (integer) required
assets/post_assets_by_id_components	Create a component for an asset	id (integer) required data: { . component_type (string) . component_data (object) } (object) required
assets/put_assets_by_id_components_by_component_id	Update a component of an asset	id (integer) required component_id (integer) required data: { . component_type (string) . component_data (object) } (object) required
assets/get_assets_by_id_contracts	List all associated contracts of an asset	id (integer) required
assets/get_assets_by_id_requests	List all associated tickets/requests for an asset	id (integer) required
assets/get_assets_by_id_relationships	List all relationships for a specific asset	id (integer) required page (integer) per_page (integer)
assets/get_assets_relationships	List all relationships across all assets	page (integer) per_page (integer)
assets/post_assets_relationships	Create asset relationships in bulk	data: { . relationships (array) } (object) required
assets/delete_assets_relationships	Delete asset relationships in bulk	data: { . relationship_ids (array) } (object) required
assets/get_assets_relationships_by_id	View a relationship	id (integer) required
assets/get_assets_relationship_types	List all relationship types	No parameters
assets_itam/get_assets	List all ITAM assets	page (integer) per_page (integer) workspace_id (integer)
assets_itam/get_assets_by_asset_id	View a single ITAM asset	asset_id (integer) required
assets_itam/put_assets_by_asset_id	Update an ITAM asset	asset_id (integer) required data: { . name (string) . description (string) . asset_type_id (integer) . asset_tag (string) . impact (string) . usage_type (string) . user_id (integer) . department_id (integer) . location_id (integer) . agent_id (integer) . group_id (integer) . custom_fields (object) } (object) required
assets_itam/delete_assets_by_asset_id	Delete an ITAM asset	asset_id (integer) required
assets_itam/put_assets_by_asset_id_custom_fields	Update custom fields for an ITAM asset	asset_id (integer) required data: { . custom_fields (object) } (object) required
attachments/get_attachments_by_attachment_id	Retrieve / Download an Attachment	attachment_id (integer) required
attachments/get_attachments_download	Download Purchase Order and Contracts Attachment	id (integer) required type (string)
attachments/post_tickets	Create a ticket including attachments. Total attachment size must not exceed 40 MB. Content-Type must be multipart/form-data; non-file fields must also be sent as form-data.	data: { . subject (string) . description (string) . email (string) . priority (integer) . status (integer) . attachments (array) } (object) required
attachments/put_tickets_by_id	Update a ticket including new attachments. Total size limit 40 MB. Must use multipart/form-data.	id (integer) required data: { . subject (string) . description (string) . email (string) . priority (integer) . status (integer) . attachments (array) } (object) required
attachments/post_tickets_by_id_conversations	Add a reply/conversation to a ticket with attachments. Total attachment size max 40 MB. Must use multipart/form-data.	id (integer) required data: { . body (string) . from_email (string) . user_id (integer) . cc_emails (array) . bcc_emails (array) . attachments (array) } (object) required
audit_logs/get_audit_logs	View Audit Logs	type (array) requester_id (integer) page (integer) per_page (integer)
audit_logs/post_audit_logs_export	Audit Log Export	data: { . type (array) . requester_id (integer) . start_date (string) . end_date (string) } (object) required
business_hours/get_business_hours	List all business hours configurations	page (integer) per_page (integer) workspace_id (integer)
business_hours/get_business_hours_by_id	View a business hours configuration	id (integer) required
cabs/post_cabs	Create a CAB	data: { . name (string) . description (string) . workspace_id (integer) . approval_type (integer) . approval_percentage (integer) . members (array) } (object) required
cabs/get_cabs	List all CABs	page (integer) per_page (integer) workspace_id (integer)
cabs/get_cabs_by_id	View a CAB	id (integer) required
cabs/put_cabs_by_id	Update a CAB	id (integer) required data: { . name (string) . description (string) . approval_type (integer) . approval_percentage (integer) } (object) required
cabs/delete_cabs_by_id	Delete a CAB	id (integer) required
cabs/get_cabs_by_cab_id_members	List all members of a CAB	cab_id (integer) required page (integer) per_page (integer)
cabs/post_cabs_by_cab_id_members	Add members to a CAB	cab_id (integer) required data: { . members (array) } (object) required
cabs/delete_cabs_by_cab_id_members_by_member_id	Remove a member from a CAB	cab_id (integer) required member_id (integer) required
canned_responses/get_canned_response_folders	List all Canned Response Folders	page (integer) per_page (integer)
canned_responses/get_canned_response_folders_by_folder_id	Show a Canned Response Folder	folder_id (integer) required
canned_responses/get_canned_response_folders_by_folder_id_responses	List all Canned Responses In a Folder	folder_id (integer) required page (integer) per_page (integer)
canned_responses/get_canned_responses	View List of Canned Responses	page (integer) per_page (integer)
canned_responses/get_canned_responses_by_response_id	Show a Canned Response	response_id (integer) required
changes/post_changes	Create a change	data: { . subject (string) . description (string) . requester_id (integer) . email (string) . agent_id (integer) . group_id (integer) . department_id (integer) . workspace_id (integer) . priority (integer) . impact (integer) . risk (integer) . change_type (integer) . status (integer) . approval_status (integer) . release_id (integer) . category (string) . sub_category (string) . item_category (string) . planned_start_date (string) . planned_end_date (string) . planning_fields (object) . custom_fields (object) . assets (array) . impacted_services (array) . attachments (array) } (object) required
changes/get_changes	List all changes supports filter query	page (integer) per_page (integer) query (string) view (string) sort_by (string) order_type (string) workspace_id (integer) updated_since (string)
changes/get_changes_by_id	View a change	id (integer) required include (string)
changes/put_changes_by_id	Update a change	id (integer) required data: { . subject (string) . description (string) . agent_id (integer) . group_id (integer) . department_id (integer) . priority (integer) . impact (integer) . risk (integer) . change_type (integer) . status (integer) . approval_status (integer) . planned_start_date (string) . planned_end_date (string) . planning_fields (object) . custom_fields (object) } (object) required
changes/delete_changes_by_id	Delete a change	id (integer) required
changes/post_changes_by_id_move	Move a change to another workspace	id (integer) required data: { . workspace_id (integer) } (object) required
changes/get_change_fields	List all change fields	No parameters
changes/post_changes_by_change_id_notes	Create a note on a change	change_id (integer) required data: { . body (string) . body_html (string) } (object) required
changes/get_changes_by_change_id_notes	List all notes for a change	change_id (integer) required page (integer) per_page (integer)
changes/get_changes_by_change_id_notes_by_note_id	View a change note	change_id (integer) required note_id (integer) required
changes/put_changes_by_change_id_notes_by_note_id	Update a change note	change_id (integer) required note_id (integer) required data: { . body (string) . body_html (string) } (object) required
changes/delete_changes_by_change_id_notes_by_note_id	Delete a change note	change_id (integer) required note_id (integer) required
changes/post_changes_by_change_id_time_entries	Create a time entry on a change	change_id (integer) required data: { . time_spent (string) . executed_at (string) . timer_running (boolean) . billable (boolean) . note (string) . agent_id (integer) } (object) required
changes/get_changes_by_change_id_time_entries	List all time entries for a change	change_id (integer) required page (integer) per_page (integer)
changes/get_changes_by_change_id_time_entries_by_time_entry_id	View a specific change time entry	change_id (integer) required time_entry_id (integer) required
changes/put_changes_by_change_id_time_entries_by_time_entry_id	Update a change time entry	change_id (integer) required time_entry_id (integer) required data: { . time_spent (string) . executed_at (string) . timer_running (boolean) . billable (boolean) . note (string) . agent_id (integer) } (object) required
changes/delete_changes_by_change_id_time_entries_by_time_entry_id	Delete a change time entry	change_id (integer) required time_entry_id (integer) required
changes/post_changes_by_change_id_tasks	Create a task on a change	change_id (integer) required data: { . title (string) . description (string) . status (integer) . due_date (string) . notify_before (integer) . group_id (integer) . agent_id (integer) } (object) required
changes/get_changes_by_change_id_tasks	List all tasks for a change	change_id (integer) required page (integer) per_page (integer)
changes/get_changes_by_change_id_tasks_by_task_id	View a change task	change_id (integer) required task_id (integer) required
changes/put_changes_by_change_id_tasks_by_task_id	Update a change task	change_id (integer) required task_id (integer) required data: { . title (string) . description (string) . status (integer) . due_date (string) . notify_before (integer) . group_id (integer) . agent_id (integer) } (object) required
changes/delete_changes_by_change_id_tasks_by_task_id	Delete a change task	change_id (integer) required task_id (integer) required
cloud_infrastructure/get_cloud_infrastructure	View cloud infrastructure details	No parameters
cloud_infrastructure/put_cloud_infrastructure	Update cloud infrastructure details	data: { . name (string) . description (string) . provider (string) . account_id (string) . workspace_id (integer) . custom_fields (object) } (object) required
cloud_infrastructure/delete_cloud_infrastructure	Delete cloud infrastructure details	No parameters
cloud_infrastructure/put_cloud_infrastructure_custom_fields	Create or update a cloud infrastructure custom field	data: { . name (string) . label (string) . field_type (string) . required (boolean) . default (boolean) } (object) required
collaborate/post_tickets_by_ticket_id_collaborations_emails	Trigger Email for a Major Incident with optional attachments	ticket_id (integer) required data: { . recipients (array) . subject (string) . body (string) } (object) required
collaborate/get_tickets_by_ticket_id_collaborations_emails	Retrieve Emails Related to a Ticket	ticket_id (integer) required page (integer) per_page (integer)
collaborate/get_tickets_by_ticket_id_collaborations_emails_by_email_id	Retrieve Specific Email using ID	ticket_id (integer) required email_id (integer) required
collaborate/post_tickets_by_ticket_id_collaborations_zoom_meetings	Trigger a New Zoom Meeting	ticket_id (integer) required data: { . topic (string) . agenda (string) . start_time (string) . duration (integer) . timezone (string) . password (string) } (object) required
collaborate/get_tickets_by_ticket_id_collaborations_zoom_meetings	Retrieve Zoom Meetings Related to a Ticket	ticket_id (integer) required page (integer) per_page (integer)
collaborate/get_tickets_by_ticket_id_collaborations_zoom_meetings_by_meeting_id	Retrieve Specific Zoom Meeting by ID	ticket_id (integer) required meeting_id (integer) required
contracts/get_contracts	List all contracts	page (integer) per_page (integer) workspace_id (integer) include (string)
contracts/post_contracts	Create a contract	data: { . contract_number (string) . name (string) . description (string) . vendor_id (integer) . auto_renew (boolean) . notify_expiry (boolean) . notify_before (integer) . approver_id (integer) . start_date (string) . end_date (string) . cost (number) . status (string) . contract_type_id (integer) . visible_to_id (integer) . notify_to (array) . software_id (integer) . item_cost_details (array) . assets (array) . license_type (string) . license_key (string) . billing_cycle (string) . custom_fields (object) . workspace_id (integer) } (object) required
contracts/get_contracts_by_contract_id	View a contract	contract_id (integer) required include (string)
contracts/put_contracts_by_contract_id	Update a contract	contract_id (integer) required data: { . contract_number (string) . name (string) . description (string) . vendor_id (integer) . auto_renew (boolean) . notify_expiry (boolean) . notify_before (integer) . approver_id (integer) . start_date (string) . end_date (string) . cost (number) . status (string) . contract_type_id (integer) . visible_to_id (integer) . notify_to (array) . item_cost_details (array) . assets (array) . custom_fields (object) } (object) required
contracts/delete_contracts_by_contract_id	Delete a contract	contract_id (integer) required
contracts/put_contracts_by_contract_id_move	Move a contract to another workspace	contract_id (integer) required data: { . workspace_id (integer) } (object) required
contracts/post_contracts_by_contract_id_approval	Submit a contract for approval	contract_id (integer) required
contracts/put_contracts_by_contract_id_approval	Approve or reject a contract	contract_id (integer) required data: { . approval_status (string) . reason (string) } (object) required
contracts/get_contracts_by_contract_id_assets	List all associated assets of a contract	contract_id (integer) required
contracts/get_contracts_by_contract_id_attachments	List all attachments of a contract	contract_id (integer) required
contracts/get_contracts_contract_types	List all contract types	No parameters
contracts/get_contracts_contract_types_by_contract_type_id_fields	List all fields for a contract type	contract_type_id (integer) required
conversations/get_tickets_by_ticket_id_conversations	List all conversations of a ticket	ticket_id (integer) required page (integer) per_page (integer)
conversations/post_tickets_by_ticket_id_conversations	Set 'note' to true to create a private/public note. Otherwise creates a reply.	ticket_id (integer) required data: { . body (string) . private (boolean) . incoming (boolean) . note (boolean) . from_email (string) . user_id (integer) . cc_emails (array) . bcc_emails (array) . attachments (array) } (object) required
conversations/post_tickets_by_ticket_id_reply	Create a reply on a ticket	ticket_id (integer) required data: { . body (string) . from_email (string) . user_id (integer) . cc_emails (array) . bcc_emails (array) . attachments (array) } (object) required
conversations/post_tickets_by_ticket_id_notes	Create a note on a ticket	ticket_id (integer) required data: { . body (string) . private (boolean) . notify_emails (array) . attachments (array) } (object) required
conversations/put_tickets_by_ticket_id_conversations_by_id	Update a conversation	ticket_id (integer) required id (integer) required data: { . body (string) . attachments (array) } (object) required
conversations/delete_tickets_by_ticket_id_conversations_by_id	Delete a conversation	ticket_id (integer) required id (integer) required
conversations/delete_tickets_by_ticket_id_conversations_by_conversation_id_attachments_by_attachment_id	Delete a conversation attachment	ticket_id (integer) required conversation_id (integer) required attachment_id (integer) required
custom_objects/get_custom_objects	View List of Custom Objects	page (integer) per_page (integer)
custom_objects/get_custom_objects_by_custom_object_id	Show a Custom Object	custom_object_id (integer) required
custom_objects/post_custom_objects_by_custom_object_id_records	Create new Custom Object Record	custom_object_id (integer) required data: { . data (object) } (object) required
custom_objects/get_custom_objects_by_custom_object_id_records	List all records of a Custom Object	custom_object_id (integer) required page (integer) per_page (integer)
custom_objects/put_custom_objects_by_custom_object_id_records_by_record_id	Update Custom Object Record	custom_object_id (integer) required record_id (integer) required data: { . data (object) } (object) required
custom_objects/delete_custom_objects_by_custom_object_id_records_by_record_id	Delete Custom Object Record	custom_object_id (integer) required record_id (integer) required
delegation/post_delegatee	Create a new delegation delegatee for the current agent	data: { . delegatee_id (integer) . start_date (string) . end_date (string) . module (string) } (object) required
delegation/get_delegatee	List all delegations for the current agent	page (integer) per_page (integer) status (string)
delegation/get_delegatee_by_id	View a delegation by id	id (integer) required
delegation/put_delegatee_by_id	Update a delegation	id (integer) required data: { . delegatee_id (integer) . start_date (string) . end_date (string) . module (string) } (object) required
delegation/delete_delegatee_by_id	Delete a delegation	id (integer) required
departments/post_departments	Create a new department	data: { . name (string) . description (string) . head_user_id (integer) . prime_user_id (integer) . domains (array) . workspace_id (integer) . custom_fields (object) } (object) required
departments/get_departments	List or filter departments	page (integer) per_page (integer) query (string) workspace_id (integer)
departments/get_departments_by_id	View a department by id	id (integer) required
departments/put_departments_by_id	Update a department	id (integer) required data: { . name (string) . description (string) . head_user_id (integer) . prime_user_id (integer) . domains (array) . workspace_id (integer) . custom_fields (object) } (object) required
departments/delete_departments_by_id	Delete a department	id (integer) required
departments/get_department_fields	List all department fields	page (integer) per_page (integer)
devices/get_devices	List all devices	page (integer) per_page (integer) workspace_id (integer)
devices/post_devices	Create a device	data: { . name (string) . description (string) . asset_type_id (integer) . asset_tag (string) . product_id (integer) . vendor (string) . hostname (string) . device_type (string) . mac_address (string) . serial_number (string) . warranty_expiry_date (string) . workspace_id (integer) . custom_fields (object) } (object) required
devices/put_devices	Create or update a device custom field	data: { . name (string) . label (string) . field_type (string) . required (boolean) . default (boolean) } (object) required
devices/get_devices_by_device_id	View a device	device_id (integer) required
devices/put_devices_by_device_id	Update a device	device_id (integer) required data: { . name (string) . description (string) . asset_type_id (integer) . asset_tag (string) . product_id (integer) . vendor (string) . hostname (string) . device_type (string) . mac_address (string) . serial_number (string) . warranty_expiry_date (string) . workspace_id (integer) . custom_fields (object) } (object) required
devices/delete_devices_by_device_id	Delete a device	device_id (integer) required
employee_offboarding/get_offboarding_form	View Offboarding Form Fields	No parameters
employee_offboarding/post_offboarding_requests	Create an Offboarding Request	data: { . initiator_id (integer) . fields (object) } (object) required
employee_offboarding/get_offboarding_requests	View all Offboarding Requests	page (integer) per_page (integer)
employee_offboarding/get_offboarding_requests_by_id	View an Offboarding Request	id (integer) required
employee_offboarding/get_offboarding_requests_by_id_tickets	View Offboarding Tickets	id (integer) required
employee_onboarding/get_onboarding_form	View Onboarding Form Fields	No parameters
employee_onboarding/post_onboarding_requests	Create an Onboarding Request	data: { . initiator_id (integer) . fields (object) } (object) required
employee_onboarding/get_onboarding_requests	View all Onboarding Requests	page (integer) per_page (integer)
employee_onboarding/get_onboarding_requests_by_id	View an Onboarding Request	id (integer) required
employee_onboarding/get_onboarding_requests_by_id_tickets	View Onboarding Tickets	id (integer) required
journeys/get_journeys	View List of Published Journeys Configs	page (integer) per_page (integer)
journeys/get_journeys_by_journey_id_initiator_config_form	View Journey Initiator Config Form Fields	journey_id (integer) required
journeys/post_journey_requests	Create a Journey Request	data: { . journey_id (integer) . initiator_id (integer) . fields (object) } (object) required
journeys/get_journey_requests	View List / Filter Journey Requests	query (string) page (integer) per_page (integer)
journeys/get_journey_requests_by_id	View a Journey Request	id (integer) required
journeys/put_journey_requests_by_id	Update a Journey Request	id (integer) required data: { . fields (object) } (object) required
journeys/delete_journey_requests_by_id	Delete a Journey Request	id (integer) required
journeys/put_journey_requests_by_id_cancel	Cancel a Journey Request	id (integer) required
journeys/get_journey_requests_by_id_activities	View Journey Request Activities	id (integer) required activity_type (string) page (integer) per_page (integer)
lifecycle_events/get_lifecycle_events	List all lifecycle events	page (integer) per_page (integer)
lifecycle_events/post_lifecycle_events	Create or update a lifecycle event	data: { . name (string) . description (string) . event_type (string) . resource_id (integer) . resource_type (string) . workspace_id (integer) . occurred_at (string) . custom_fields (object) } (object) required
lifecycle_events/get_lifecycle_events_by_id	View a lifecycle event	id (integer) required
lifecycle_events/delete_lifecycle_events_by_id	Delete a lifecycle event	id (integer) required
locations/post_locations	Create a new location	data: { . name (string) . parent_location_id (integer) . primary_contact_id (integer) . address (object) . contact_name (string) . phone (string) . email (string) . workspace_id (integer) } (object) required
locations/get_locations	List all locations	page (integer) per_page (integer) workspace_id (integer)
locations/get_locations_by_id	View a location by id	id (integer) required
locations/put_locations_by_id	Update a location	id (integer) required data: { . name (string) . parent_location_id (integer) . primary_contact_id (integer) . address (object) . contact_name (string) . phone (string) . email (string) . workspace_id (integer) } (object) required
locations/delete_locations_by_id	Delete a location	id (integer) required
oncall_management/post_schedules	Create a Schedule	data: { . name (string) . description (string) . time_zone (string) . group_id (integer) } (object) required
oncall_management/get_schedules	View All / Filter Schedules	page (integer) per_page (integer) query (string)
oncall_management/get_schedules_by_id	View a Schedule	id (integer) required
oncall_management/put_schedules_by_id	Update a Schedule	id (integer) required data: { . name (string) . description (string) . time_zone (string) . group_id (integer) } (object) required
oncall_management/delete_schedules_by_id	Delete a Schedule	id (integer) required
oncall_management/post_shifts	Create a Shift	data: { . name (string) . schedule_id (integer) . start_time (string) . end_time (string) . users (array) . rotation (string) } (object) required
oncall_management/get_shifts	View All Shifts	page (integer) per_page (integer)
oncall_management/get_shifts_by_id	View a Shift	id (integer) required
oncall_management/put_shifts_by_id	Update a Shift	id (integer) required data: { . name (string) . start_time (string) . end_time (string) . users (array) . rotation (string) } (object) required
oncall_management/delete_shifts_by_id	Delete a Shift	id (integer) required
oncall_management/post_overrides	Create an Override	data: { . schedule_id (integer) . user_id (integer) . start_time (string) . end_time (string) } (object) required
oncall_management/put_overrides_by_id	Update an Override	id (integer) required data: { . user_id (integer) . start_time (string) . end_time (string) } (object) required
oncall_management/delete_overrides_by_id	Delete an Override	id (integer) required
oncall_management/get_users_by_user_id_oncall_calendar_events	View Oncall Calendar Events for a User	user_id (integer) required start_time (string) end_time (string)
oncall_management/get_schedules_by_schedule_id_oncall_calendar_events	View Oncall Calendar Events for a Schedule	schedule_id (integer) required start_time (string) end_time (string)
oncall_management/get_shifts_by_shift_id_oncall_calendar_events	View Oncall Calendar Events for a Shift	shift_id (integer) required start_time (string) end_time (string)
oncall_management/get_oncall_who_is_oncall	View Who is Oncall	schedule_id (integer) escalation_policy_id (integer)
oncall_management/post_escalation_policies	Create an Escalation Policy	data: { . name (string) . description (string) . rules (array) } (object) required
oncall_management/get_escalation_policies	View All Escalation Policies	page (integer) per_page (integer)
oncall_management/get_escalation_policies_by_id	View an Escalation Policy	id (integer) required
oncall_management/put_escalation_policies_by_id	Update an Escalation Policy	id (integer) required data: { . name (string) . description (string) . rules (array) } (object) required
oncall_management/delete_escalation_policies_by_id	Delete an Escalation Policy	id (integer) required
oncall_management/put_escalation_policies_by_id_reorder	Reorder an Escalation Policy	id (integer) required data: { . position (integer) } (object) required
physical_subtypes/get_physical_subtypes	List physical subtypes	page (integer) per_page (integer)
physical_subtypes/post_physical_subtypes	Create or update a physical subtype	data: { . name (string) . description (string) . asset_type_id (integer) . custom_fields (object) } (object) required
physical_subtypes/get_physical_subtypes_by_id	View a physical subtype	id (integer) required
physical_subtypes/delete_physical_subtypes_by_id	Delete a physical subtype	id (integer) required
post_incident_reports/post_post_incident_report_templates	Create a post-incident report template	data: { . name (string) . description (string) . workspace_id (integer) . is_primary (boolean) . enabled (boolean) . sections (array) } (object) required
post_incident_reports/get_post_incident_report_templates	List all post-incident report templates	page (integer) per_page (integer) workspace_id (integer)
post_incident_reports/get_post_incident_report_templates_by_id	View a post-incident report template	id (integer) required
post_incident_reports/delete_post_incident_report_templates_by_id	Delete a post-incident report template	id (integer) required
post_incident_reports/put_post_incident_report_templates_by_id_enable	Enable a post-incident report template	id (integer) required
post_incident_reports/put_post_incident_report_templates_by_id_mark_primary	Set a post-incident report template as the primary	id (integer) required
post_incident_reports/get_post_incident_report_templates_by_id_export	Export a post-incident report template	id (integer) required
problems/post_problems	Create a problem	data: { . subject (string) . description (string) . description_html (string) . requester_id (integer) . email (string) . agent_id (integer) . group_id (integer) . department_id (integer) . workspace_id (integer) . priority (integer) . impact (integer) . status (integer) . known_error (boolean) . due_by (string) . category (string) . sub_category (string) . item_category (string) . associated_change (integer) . assets (array) . problem_cause (string) . problem_symptom (string) . problem_impact (string) . custom_fields (object) . attachments (array) } (object) required
problems/get_problems	List all problems	page (integer) per_page (integer) workspace_id (integer) updated_since (string)
problems/get_problems_by_id	View a problem	id (integer) required include (string)
problems/put_problems_by_id	Update a problem	id (integer) required data: { . subject (string) . description (string) . description_html (string) . agent_id (integer) . group_id (integer) . department_id (integer) . priority (integer) . impact (integer) . status (integer) . known_error (boolean) . due_by (string) . problem_cause (string) . problem_symptom (string) . problem_impact (string) . custom_fields (object) } (object) required
problems/delete_problems_by_id	Delete a problem	id (integer) required
problems/put_problems_by_id_restore	Restore a soft-deleted problem	id (integer) required
problems/get_problem_fields	List all problem fields	No parameters
problems/post_problems_by_problem_id_notes	Create a note on a problem	problem_id (integer) required data: { . body (string) . notify_emails (array) } (object) required
problems/get_problems_by_problem_id_notes	List all notes for a problem	problem_id (integer) required page (integer) per_page (integer)
problems/get_problems_by_problem_id_notes_by_note_id	View a specific problem note	problem_id (integer) required note_id (integer) required
problems/put_problems_by_problem_id_notes_by_note_id	Update a problem note	problem_id (integer) required note_id (integer) required data: { . body (string) . notify_emails (array) } (object) required
problems/delete_problems_by_problem_id_notes_by_note_id	Delete a problem note	problem_id (integer) required note_id (integer) required
problems/post_problems_by_problem_id_time_entries	Create a time entry on a problem	problem_id (integer) required data: { . time_spent (string) . executed_at (string) . timer_running (boolean) . billable (boolean) . note (string) . agent_id (integer) } (object) required
problems/get_problems_by_problem_id_time_entries	List all time entries for a problem	problem_id (integer) required page (integer) per_page (integer)
problems/get_problems_by_problem_id_time_entries_by_time_entry_id	View a specific problem time entry	problem_id (integer) required time_entry_id (integer) required
problems/put_problems_by_problem_id_time_entries_by_time_entry_id	Update a problem time entry	problem_id (integer) required time_entry_id (integer) required data: { . time_spent (string) . executed_at (string) . timer_running (boolean) . billable (boolean) . note (string) . agent_id (integer) } (object) required
problems/delete_problems_by_problem_id_time_entries_by_time_entry_id	Delete a problem time entry	problem_id (integer) required time_entry_id (integer) required
problems/post_problems_by_problem_id_tasks	Create a task on a problem	problem_id (integer) required data: { . title (string) . description (string) . status (integer) . due_date (string) . notify_before (integer) . group_id (integer) . agent_id (integer) } (object) required
problems/get_problems_by_problem_id_tasks	List all tasks for a problem	problem_id (integer) required page (integer) per_page (integer)
problems/get_problems_by_problem_id_tasks_by_task_id	View a specific problem task	problem_id (integer) required task_id (integer) required
problems/put_problems_by_problem_id_tasks_by_task_id	Update a problem task	problem_id (integer) required task_id (integer) required data: { . title (string) . description (string) . status (integer) . due_date (string) . notify_before (integer) . group_id (integer) . agent_id (integer) } (object) required
problems/delete_problems_by_problem_id_tasks_by_task_id	Delete a problem task	problem_id (integer) required task_id (integer) required
products/get_products	List all products	page (integer) per_page (integer) workspace_id (integer)
products/post_products	Create a new product	data: { . name (string) . asset_type_id (integer) . manufacturer (string) . status (string) . mode_of_procurement (string) . depreciation_type_id (integer) . description (string) . workspace_id (integer) } (object) required
products/get_products_by_id	View a product	id (integer) required
products/put_products_by_id	Update a product	id (integer) required data: { . name (string) . asset_type_id (integer) . manufacturer (string) . status (string) . mode_of_procurement (string) . depreciation_type_id (integer) . description (string) } (object) required
products/delete_products_by_id	Delete a product	id (integer) required
project_tasks/post_projects_by_project_id_tasks	Create a project task	project_id (integer) required data: { . title (string) . description (string) . assignee_id (integer) . due_date (string) . priority (integer) . status (integer) } (object) required
project_tasks/get_projects_by_project_id_tasks	View all project tasks	project_id (integer) required page (integer) per_page (integer)
project_tasks/get_projects_by_project_id_tasks_by_task_id	View a project task	project_id (integer) required task_id (integer) required
project_tasks/put_projects_by_project_id_tasks_by_task_id	Update a project task	project_id (integer) required task_id (integer) required data: { . title (string) . description (string) . assignee_id (integer) . due_date (string) . priority (integer) . status (integer) } (object) required
project_tasks/delete_projects_by_project_id_tasks_by_task_id	Delete a project task	project_id (integer) required task_id (integer) required
project_tasks_new_gen/post_project_tasks	Create a NewGen project task	data: { . project_id (integer) . title (string) . description (string) . assignee_id (integer) . due_date (string) . priority (integer) . status (integer) . type_id (integer) } (object) required
project_tasks_new_gen/get_project_tasks	List all NewGen project tasks optionally filtered	page (integer) per_page (integer) filter (string)
project_tasks_new_gen/get_project_tasks_by_task_id	View a NewGen project task	task_id (integer) required
project_tasks_new_gen/put_project_tasks_by_task_id	Update a NewGen project task	task_id (integer) required data: { . title (string) . description (string) . assignee_id (integer) . due_date (string) . priority (integer) . status (integer) . type_id (integer) } (object) required
project_tasks_new_gen/delete_project_tasks_by_task_id	Delete a NewGen project task	task_id (integer) required
project_tasks_new_gen/get_project_tasks_type_fields	View project task type fields	No parameters
project_tasks_new_gen/get_project_task_types	View project task types	No parameters
project_tasks_new_gen/get_project_task_priorities	View project task priorities	No parameters
project_tasks_new_gen/get_project_task_statuses	View project task statuses	No parameters
project_tasks_new_gen/post_project_tasks_by_task_id_associations	Create task association	task_id (integer) required data: { . associated_entity_type (string) . associated_entity_id (integer) } (object) required
project_tasks_new_gen/get_project_tasks_by_task_id_associations	View task associations	task_id (integer) required
project_tasks_new_gen/delete_project_tasks_by_task_id_associations_by_association_id	Delete task association	task_id (integer) required association_id (integer) required
project_tasks_new_gen/post_project_tasks_by_task_id_notes	Create task note	task_id (integer) required data: { . body (string) . attachments (array) } (object) required
project_tasks_new_gen/get_project_tasks_by_task_id_notes	View task notes	task_id (integer) required
project_tasks_new_gen/put_project_tasks_by_task_id_notes_by_note_id	Update task note	task_id (integer) required note_id (integer) required data: { . body (string) . attachments (array) } (object) required
project_tasks_new_gen/delete_project_tasks_by_task_id_notes_by_note_id	Delete task note	task_id (integer) required note_id (integer) required
project_tasks_new_gen/delete_project_tasks_by_task_id_attachments_by_attachment_id	Delete attachment of a project task	task_id (integer) required attachment_id (integer) required
project_tasks_new_gen/delete_project_tasks_by_task_id_notes_by_note_id_attachments_by_attachment_id	Delete attachment of a task note	task_id (integer) required note_id (integer) required attachment_id (integer) required
projects/post_projects	Create a new project	data: { . name (string) . description (string) . key (string) . start_date (string) . end_date (string) . status (integer) . priority (integer) . owner_id (integer) . visibility (string) } (object) required
projects/get_projects	View all projects	page (integer) per_page (integer)
projects/get_projects_by_id	View a project	id (integer) required
projects/put_projects_by_id	Update a project	id (integer) required data: { . name (string) . description (string) . status (integer) . priority (integer) . owner_id (integer) . end_date (string) } (object) required
projects/delete_projects_by_id	Delete a project	id (integer) required
projects/put_projects_by_id_archive	Archive a project	id (integer) required
projects/put_projects_by_id_restore	Restore an archived project	id (integer) required
projects_new_gen/post_projects	Create a new NewGen project	data: { . name (string) . key (string) . description (string) . status (string) . template_id (integer) } (object) required
projects_new_gen/get_projects	View all NewGen projects	page (integer) per_page (integer)
projects_new_gen/get_projects_by_id	View a NewGen project	id (integer) required
projects_new_gen/put_projects_by_id	Update a NewGen project	id (integer) required data: { . name (string) . description (string) . status (string) } (object) required
projects_new_gen/delete_projects_by_id	Delete a NewGen project	id (integer) required
projects_new_gen/put_projects_by_id_archive	Archive a NewGen project	id (integer) required
projects_new_gen/put_projects_by_id_restore	Restore a NewGen project	id (integer) required
projects_new_gen/get_projects_fields	View NewGen project fields	No parameters
projects_new_gen/get_project_templates	View NewGen project templates	No parameters
projects_new_gen/post_projects_by_id_members	Add members to a NewGen project	id (integer) required data: { . members (array) } (object) required
projects_new_gen/post_projects_by_id_associations	Create a project association	id (integer) required data: { . associated_entity_type (string) . associated_entity_id (integer) } (object) required
projects_new_gen/get_projects_by_id_associations	View project associations	id (integer) required
projects_new_gen/delete_projects_by_id_associations_by_association_id	Delete a project association	id (integer) required association_id (integer) required
projects_new_gen/delete_projects_by_id_attachments_by_attachment_id	Delete attachment of a project	id (integer) required attachment_id (integer) required
purchase_orders/get_purchase_orders	List all purchase orders	page (integer) per_page (integer) workspace_id (integer) include (string)
purchase_orders/post_purchase_orders	Create a new purchase order	data: { . name (string) . po_number (string) . vendor_id (integer) . expected_delivery_date (string) . shipping_address (object) . billing_same_as_shipping (boolean) . billing_address . currency_code (string) . conversion_rate (number) . department_id (integer) . discount_percentage (number) . shipping_cost (number) . tax_percentage (number) . purchase_items (array) . custom_fields (object) . workspace_id (integer) } (object) required
purchase_orders/get_purchase_orders_by_id	View a purchase order	id (integer) required include (string)
purchase_orders/put_purchase_orders_by_id	Update a purchase order	id (integer) required data: { . name (string) . po_number (string) . vendor_id (integer) . expected_delivery_date (string) . shipping_address (object) . billing_same_as_shipping (boolean) . billing_address . currency_code (string) . conversion_rate (number) . department_id (integer) . discount_percentage (number) . shipping_cost (number) . tax_percentage (number) . purchase_items (array) . custom_fields (object) } (object) required
purchase_orders/delete_purchase_orders_by_id	Delete a purchase order	id (integer) required
purchase_orders/put_purchase_orders_by_id_send_for_approval	Send a purchase order for approval	id (integer) required data: { . approver_ids (array) } (object) required
purchase_orders/put_purchase_orders_by_id_mark_items_as_received	Mark items of a purchase order as received	id (integer) required data: { . purchase_items (array) } (object) required
purchase_orders/put_purchase_orders_by_id_move_workspace	Move a purchase order to another workspace	id (integer) required data: { . workspace_id (integer) } (object) required
releases/post_releases	Create a release	data: { . subject (string) . description (string) . workspace_id (integer) . agent_id (integer) . group_id (integer) . department_id (integer) . priority (integer) . status (integer) . release_type (integer) . planned_start_date (string) . planned_end_date (string) . category (string) . sub_category (string) . item_category (string) . associated_change_ids (array) . planning_fields (object) . custom_fields (object) . attachments (array) } (object) required
releases/get_releases	List all releases	page (integer) per_page (integer) workspace_id (integer) updated_since (string)
releases/get_releases_by_id	View a release	id (integer) required include (string)
releases/put_releases_by_id	Update a release	id (integer) required data: { . subject (string) . description (string) . agent_id (integer) . group_id (integer) . department_id (integer) . priority (integer) . status (integer) . release_type (integer) . planned_start_date (string) . planned_end_date (string) . planning_fields (object) . custom_fields (object) } (object) required
releases/delete_releases_by_id	Delete a release	id (integer) required
releases/put_releases_by_id_move	Move a release to another workspace	id (integer) required data: { . workspace_id (integer) } (object) required
releases/post_releases_by_release_id_notes	Create a note on a release	release_id (integer) required data: { . body (string) . body_html (string) } (object) required
releases/get_releases_by_release_id_notes	List all notes for a release	release_id (integer) required page (integer) per_page (integer)
releases/get_releases_by_release_id_notes_by_note_id	View a release note	release_id (integer) required note_id (integer) required
releases/put_releases_by_release_id_notes_by_note_id	Update a release note	release_id (integer) required note_id (integer) required data: { . body (string) . body_html (string) } (object) required
releases/delete_releases_by_release_id_notes_by_note_id	Delete a release note	release_id (integer) required note_id (integer) required
releases/post_releases_by_release_id_tasks	Create a task on a release	release_id (integer) required data: { . title (string) . description (string) . status (integer) . due_date (string) . notify_before (integer) . group_id (integer) . agent_id (integer) . stage (integer) } (object) required
releases/get_releases_by_release_id_tasks	List all tasks for a release	release_id (integer) required page (integer) per_page (integer)
releases/get_releases_by_release_id_tasks_by_task_id	View a release task	release_id (integer) required task_id (integer) required
releases/put_releases_by_release_id_tasks_by_task_id	Update a release task	release_id (integer) required task_id (integer) required data: { . title (string) . description (string) . status (integer) . due_date (string) . notify_before (integer) . group_id (integer) . agent_id (integer) . stage (integer) } (object) required
releases/delete_releases_by_release_id_tasks_by_task_id	Delete a release task	release_id (integer) required task_id (integer) required
releases/post_releases_by_release_id_time_entries	Create a time entry on a release	release_id (integer) required data: { . time_spent (string) . executed_at (string) . timer_running (boolean) . billable (boolean) . note (string) . agent_id (integer) } (object) required
releases/get_releases_by_release_id_time_entries	List all time entries for a release	release_id (integer) required page (integer) per_page (integer)
releases/get_releases_by_release_id_time_entries_by_time_entry_id	View a release time entry	release_id (integer) required time_entry_id (integer) required
releases/put_releases_by_release_id_time_entries_by_time_entry_id	Update a release time entry	release_id (integer) required time_entry_id (integer) required data: { . time_spent (string) . executed_at (string) . timer_running (boolean) . billable (boolean) . note (string) . agent_id (integer) } (object) required
releases/delete_releases_by_release_id_time_entries_by_time_entry_id	Delete a release time entry	release_id (integer) required time_entry_id (integer) required
requester_groups/post_requester_groups	Create a new requester group	data: { . name (string) . description (string) . type (string) } (object) required
requester_groups/get_requester_groups	List all requester groups	page (integer) per_page (integer)
requester_groups/get_requester_groups_by_id	View a requester group by id	id (integer) required
requester_groups/put_requester_groups_by_id	Update a requester group	id (integer) required data: { . name (string) . description (string) } (object) required
requester_groups/delete_requester_groups_by_id	Delete a requester group	id (integer) required
requester_groups/get_requester_groups_by_id_members	List members of a requester group	id (integer) required page (integer) per_page (integer)
requester_groups/post_requester_groups_by_id_members_by_user_id	Add a requester to a requester group	id (integer) required user_id (integer) required
requester_groups/delete_requester_groups_by_id_members_by_user_id	Remove a requester from a requester group	id (integer) required user_id (integer) required
requesters/post_requesters	Create a new requester contact	data: { . first_name (string) . last_name (string) . job_title (string) . primary_email (string) . secondary_emails (array) . work_phone_number (string) . mobile_phone_number (string) . department_ids (array) . can_see_all_tickets_from_associated_departments (boolean) . reporting_manager_id (integer) . address (string) . time_zone (string) . time_format (string) . language (string) . location_id (integer) . background_information (string) . workspace_ids (array) . external_id (string) . custom_fields (object) } (object) required
requesters/get_requesters	List all requesters or filter with query	email (string) mobile (string) phone (string) department_id (integer) include_agents (boolean) query (string) page (integer) per_page (integer)
requesters/get_requesters_by_id	View a requester by id	id (integer) required
requesters/put_requesters_by_id	Update a requester	id (integer) required data: { . first_name (string) . last_name (string) . job_title (string) . primary_email (string) . secondary_emails (array) . work_phone_number (string) . mobile_phone_number (string) . department_ids (array) . can_see_all_tickets_from_associated_departments (boolean) . reporting_manager_id (integer) . address (string) . time_zone (string) . time_format (string) . language (string) . location_id (integer) . background_information (string) . workspace_ids (array) . external_id (string) . custom_fields (object) } (object) required
requesters/delete_requesters_by_id	Deactivate a requester	id (integer) required
requesters/delete_requesters_by_id_forget	Permanently delete a requester and their tickets GDPR forget	id (integer) required
requesters/put_requesters_by_id_convert_to_agent	Convert a requester into a full-time or occasional agent	id (integer) required
requesters/put_requesters_by_id_reactivate	Reactivate a deactivated requester	id (integer) required
requesters/post_requesters_by_primary_id_merge	Merge secondary requesters into a primary requester	primary_id (integer) required secondary_requesters (string) required
requesters/get_requesters_by_id_user_assignment_history	Get the assignment history of a requester	id (integer) required
requesters/get_requester_fields	List all requester contact fields	No parameters
resource_relationships/get_resource_relationships	List all cloud resource relationships	page (integer) per_page (integer) resource_id (integer)
resource_relationships/delete_resource_relationships_by_id	Delete a cloud resource relationship	id (integer) required
resources/get_resources	List all cloud resources	page (integer) per_page (integer)
resources/get_resources_by_resource_id	View a cloud resource	resource_id (integer) required
resources/put_resources_by_resource_id	Update a cloud resource	resource_id (integer) required data: { . name (string) . description (string) . workspace_id (integer) . custom_fields (object) } (object) required
resources/delete_resources_by_resource_id	Delete a cloud resource	resource_id (integer) required
resources/post_resources_by_resource_id_custom_fields	Create a resource custom field	resource_id (integer) required data: { . custom_fields (object) } (object) required
resources/put_resources_by_resource_id_custom_fields	Update a resource custom field	resource_id (integer) required data: { . custom_fields (object) } (object) required
service_catalog/get_service_items	List all service items	page (integer) per_page (integer)
service_catalog/post_service_items	Create a service catalog item	data: { . name (string) . description (string) . short_description (string) . category_id (integer) . agent_group_visibilities (array) . shared_fields (array) } (object) required
service_catalog/get_service_items_by_id	View a service item	id (integer) required
service_catalog/put_service_items_by_id	Update a service item	id (integer) required data: { . name (string) . description (string) . short_description (string) . category_id (integer) } (object) required
service_catalog/delete_service_items_by_id	Delete a service item	id (integer) required
service_catalog/get_service_items_search	Search service items	query (string) required
service_catalog/get_service_categories	List all service categories	page (integer) per_page (integer)
service_catalog/get_shared_fields	List shared fields based on search	query (string)
service_catalog/post_shared_fields	Create a shared field	data: { . name (string) . type (string) . visibility (string) } (object) required
service_catalog/put_shared_fields_by_id	Update a shared field	id (integer) required data: { . name (string) . type (string) . visibility (string) } (object) required
service_catalog/delete_shared_fields_by_id	Delete a shared field	id (integer) required
service_catalog/get_shared_fields_by_id_data	Retrieve shared field data	id (integer) required
service_catalog/put_shared_fields_by_id_archive	Archive a shared field	id (integer) required
service_catalog/put_shared_fields_by_id_unarchive	Unarchive a shared field	id (integer) required
sla_policies/get_sla_policies	List all SLA policies	page (integer) per_page (integer) workspace_id (integer)
software/get_applications	List all software applications	page (integer) per_page (integer) workspace_id (integer)
software/post_applications	Create a new software	data: { . name (string) . description (string) . application_type (string) . status (string) . publisher_id (integer) . managed_by_id (integer) . notes (string) . category (string) . workspace_id (integer) } (object) required
software/delete_applications	Delete multiple software in bulk	data: { . ids (array) } (object) required
software/get_applications_by_id	View a software	id (integer) required
software/put_applications_by_id	Update a software	id (integer) required data: { . name (string) . description (string) . application_type (string) . status (string) . publisher_id (integer) . managed_by_id (integer) . notes (string) . category (string) } (object) required
software/delete_applications_by_id	Delete a software	id (integer) required
software/get_applications_by_id_licenses	List all licenses of a software	id (integer) required
software/put_applications_by_id_move_workspace	Move a software to another workspace	id (integer) required data: { . workspace_id (integer) } (object) required
software/get_applications_by_id_users	List all users of a software	id (integer) required page (integer) per_page (integer)
software/post_applications_by_id_users	Add users to a software in bulk	id (integer) required data: { . application_users (array) } (object) required
software/put_applications_by_id_users	Update users of a software in bulk	id (integer) required data: { . application_users (array) } (object) required
software/delete_applications_by_id_users	Remove users from a software in bulk	id (integer) required data: { . user_ids (array) } (object) required
software/get_applications_by_id_users_by_user_id	View a specific user of a software	id (integer) required user_id (integer) required
software/get_applications_by_id_installations	List all installations of a software	id (integer) required page (integer) per_page (integer)
software/post_applications_by_id_installations	Add a device installation to a software	id (integer) required data: { . installations (array) } (object) required
software/delete_applications_by_id_installations	Remove device installations from a software in bulk	id (integer) required data: { . installation_ids (array) } (object) required
software/get_applications_by_id_relationships	List all relationships for a software	id (integer) required
solution_articles/post_solution_articles	Create a solution article	data: { . title (string) . description (string) . folder_id (integer) . status (integer) . source_url (string) . attachments (array) } (object) required
solution_articles/get_solution_articles	List solution articles	folder_id (integer) page (integer) per_page (integer) filter (string)
solution_articles/get_solution_articles_search	Search solution articles	query (string) required folder_id (integer) page (integer) per_page (integer)
solution_articles/put_solution_articles_restore	Bulk restore solution articles	data: { . article_ids (array) } (object) required
solution_articles/get_solution_articles_by_id	View a solution article	id (integer) required include (string)
solution_articles/put_solution_articles_by_id	Update a solution article	id (integer) required data: { . title (string) . description (string) . status (integer) . folder_id (integer) } (object) required
solution_articles/delete_solution_articles_by_id	Delete a solution article move to trash	id (integer) required
solution_articles/post_solution_articles_by_id_translations	Create a secondary language translation of an article	id (integer) required data: { . language (string) . title (string) . description (string) } (object) required
solution_articles/post_solution_articles_by_id_approval	Send an article for approval	id (integer) required data: { . approver_ids (array) } (object) required
solution_articles/put_solution_articles_by_id_publish	Publish a solution article	id (integer) required data: { . publish_date (string) } (object) required
solution_articles/put_solution_articles_by_id_restore	Restore a deleted solution article	id (integer) required
solution_articles/delete_solution_articles_by_id_forever	Permanently delete a solution article	id (integer) required
solution_categories/post_solution_categories	Create a solution category	data: { . name (string) . description (string) . parent_id (integer) } (object) required
solution_categories/get_solution_categories	List solution categories	page (integer) per_page (integer) filter (string)
solution_categories/get_solution_categories_by_id	View a solution category	id (integer) required
solution_categories/put_solution_categories_by_id	Update a solution category	id (integer) required data: { . name (string) . description (string) . parent_id (integer) } (object) required
solution_categories/delete_solution_categories_by_id	Delete a solution category move to trash	id (integer) required
solution_categories/put_solution_categories_by_id_restore	Restore a deleted solution category	id (integer) required
solution_categories/delete_solution_categories_by_id_permanently_delete	Permanently delete a solution category	id (integer) required
solution_folders/post_solution_folders	Create a solution folder	data: { . name (string) . description (string) . category_id (integer) . parent_folder_id (integer) . require_approval (boolean) } (object) required
solution_folders/get_solution_folders	List solution folders	category_id (integer) required page (integer) per_page (integer)
solution_folders/get_solution_folders_by_id	View a solution folder	id (integer) required include (string)
solution_folders/put_solution_folders_by_id	Update a solution folder	id (integer) required data: { . name (string) . description (string) . parent_folder_id (integer) } (object) required
solution_folders/delete_solution_folders_by_id	Delete a solution folder soft delete	id (integer) required
solution_folders/get_solution_folders_by_id_sub_folders	View sub folders of a solution folder	id (integer) required page (integer) per_page (integer)
solution_folders/put_solution_folders_by_id_restore	Restore a deleted solution folder	id (integer) required
solution_folders/delete_solution_folders_by_id_permanently_delete	Permanently delete a solution folder	id (integer) required
status_page/get_status_pages_incidents	List all status page incidents	page (integer) per_page (integer)
status_page/post_status_pages_incidents	Create a status page incident	data: { . title (string) . description (string) . status (string) . impact (string) } (object) required
status_page/get_status_pages_incidents_by_incident_id	View a status page incident	incident_id (integer) required
status_page/put_status_pages_incidents_by_incident_id	Update a status page incident	incident_id (integer) required data: { . title (string) . description (string) . status (string) } (object) required
status_page/delete_status_pages_incidents_by_incident_id	Delete a status page incident	incident_id (integer) required
status_page/get_status_pages_incidents_by_incident_id_updates	List all updates for a status page incident	incident_id (integer) required
status_page/post_status_pages_incidents_by_incident_id_updates	Create a status page incident update	incident_id (integer) required data: { . body (string) . status (string) } (object) required
status_page/put_status_pages_incidents_by_incident_id_updates_by_update_id	Edit a status page incident update	incident_id (integer) required update_id (integer) required data: { . body (string) . status (string) } (object) required
status_page/delete_status_pages_incidents_by_incident_id_updates_by_update_id	Delete a status page incident update	incident_id (integer) required update_id (integer) required
status_page/get_status_pages_maintenances	List all status page maintenances	page (integer) per_page (integer)
status_page/post_status_pages_maintenances_from_change	Create a status page maintenance from a change	data: { . change_id (integer) . title (string) . description (string) . start_time (string) . end_time (string) . status (string) } (object) required
status_page/put_status_pages_maintenances_by_maintenance_id_from_change	Update a status page maintenance from a change	maintenance_id (integer) required data: { . change_id (integer) . title (string) . description (string) . start_time (string) . end_time (string) . status (string) } (object) required
status_page/get_status_pages_maintenance_statuses	List all maintenance statuses	No parameters
status_page/get_status_pages_services	List all status page service components	No parameters
status_page/get_status_pages_services_by_service_id	View a status page service component	service_id (integer) required
status_page/get_status_pages_subscribers	List all status page subscribers	No parameters
status_page/post_status_pages_subscribers	Create a status page subscriber	data: { . email (string) . phone (string) } (object) required
status_page/get_status_pages_subscribers_by_subscriber_id	View a status page subscriber	subscriber_id (integer) required
status_page/put_status_pages_subscribers_by_subscriber_id	Update a status page subscriber	subscriber_id (integer) required data: { . email (string) . phone (string) } (object) required
status_page/delete_status_pages_subscribers_by_subscriber_id	Delete a status page subscriber	subscriber_id (integer) required
tickets/post_tickets	Create a new ticket	data: { . subject (string) . description (string) . email (string) . requester_id (integer) . phone (string) . name (string) . priority (integer) . status (integer) . source (integer) . cc_emails (array) . group_id (integer) . responder_id (integer) . tags (array) . department_id (integer) . workspace_id (integer) . category (string) . sub_category (string) . item_category (string) . urgency (integer) . impact (integer) . due_by (string) . fr_due_by (string) . custom_fields (object) . attachments (array) . assets (array) . problem (object) . change_initiating_ticket (object) . change_initiated_by_ticket (object) } (object) required
tickets/get_tickets	List all tickets supports filtering	page (integer) per_page (integer) filter (string) query (string) include (string) workspace_id (integer) requester_id (integer) email (string) updated_since (string) order_type (string)
tickets/get_tickets_by_id	View a ticket by id	id (integer) required include (string)
tickets/put_tickets_by_id	Update a ticket also used to restore or move workspace	id (integer) required data: { . subject (string) . description (string) . priority (integer) . status (integer) . source (integer) . requester_id (integer) . email (string) . group_id (integer) . responder_id (integer) . tags (array) . cc_emails (array) . department_id (integer) . workspace_id (integer) . urgency (integer) . impact (integer) . due_by (string) . custom_fields (object) . deleted (boolean) } (object) required
tickets/delete_tickets_by_id	Delete a ticket	id (integer) required
tickets/put_tickets_by_id_restore	Restore a soft-deleted ticket	id (integer) required
tickets/post_tickets_by_parent_id_child_tickets	Create a child ticket for a parent ticket	parent_id (integer) required data: { . subject (string) . description (string) . email (string) . requester_id (integer) . phone (string) . name (string) . priority (integer) . status (integer) . source (integer) . cc_emails (array) . group_id (integer) . responder_id (integer) . tags (array) . department_id (integer) . workspace_id (integer) . category (string) . sub_category (string) . item_category (string) . urgency (integer) . impact (integer) . due_by (string) . fr_due_by (string) . custom_fields (object) . attachments (array) . assets (array) . problem (object) . change_initiating_ticket (object) . change_initiated_by_ticket (object) } (object) required
tickets/delete_tickets_by_id_attachments_by_attachment_id	Delete a ticket attachment	id (integer) required attachment_id (integer) required
tickets/get_tickets_by_id_activities	Get activity log for a ticket	id (integer) required page (integer) per_page (integer)
tickets/post_tickets_by_ticket_id_time_entries	Create a time entry on a ticket	ticket_id (integer) required data: { . time_spent (string) . executed_at (string) . timer_running (boolean) . billable (boolean) . note (string) . agent_id (integer) . start_time (string) } (object) required
tickets/get_tickets_by_ticket_id_time_entries	List all time entries for a ticket	ticket_id (integer) required page (integer) per_page (integer)
tickets/get_tickets_by_ticket_id_time_entries_by_id	View a specific time entry	ticket_id (integer) required id (integer) required
tickets/put_tickets_by_ticket_id_time_entries_by_id	Update a time entry	ticket_id (integer) required id (integer) required data: { . time_spent (string) . executed_at (string) . timer_running (boolean) . billable (boolean) . note (string) . agent_id (integer) . start_time (string) } (object) required
tickets/delete_tickets_by_ticket_id_time_entries_by_id	Delete a time entry	ticket_id (integer) required id (integer) required
tickets/post_tickets_by_ticket_id_tasks	Create a task on a ticket	ticket_id (integer) required data: { . title (string) . description (string) . status (integer) . due_date (string) . notify_before (integer) . group_id (integer) . agent_id (integer) } (object) required
tickets/get_tickets_by_ticket_id_tasks	List all tasks for a ticket	ticket_id (integer) required page (integer) per_page (integer)
tickets/get_tickets_by_ticket_id_tasks_by_id	View a specific task	ticket_id (integer) required id (integer) required
tickets/put_tickets_by_ticket_id_tasks_by_id	Update a task	ticket_id (integer) required id (integer) required data: { . title (string) . description (string) . status (integer) . due_date (string) . notify_before (integer) . group_id (integer) . agent_id (integer) } (object) required
tickets/delete_tickets_by_ticket_id_tasks_by_id	Delete a task	ticket_id (integer) required id (integer) required
tickets/get_ticket_fields	List all ticket fields	No parameters
tickets/get_tickets_by_ticket_id_csat_response	View CSAT response for a ticket	ticket_id (integer) required
tickets/put_tickets_by_id_promote_to_major_incident	Promote an incident to a major incident	id (integer) required
tickets/put_tickets_by_id_demote_from_major_incident	Demote an incident from being a major incident	id (integer) required
vendors/get_vendors	List all vendors	page (integer) per_page (integer) workspace_id (integer)
vendors/post_vendors	Create a new vendor	data: { . name (string) . description (string) . contact_name (string) . email (string) . mobile (string) . phone (string) . primary_contact_id (integer) . address (object) . custom_fields (object) . workspace_id (integer) } (object) required
vendors/get_vendors_by_id	View a vendor	id (integer) required
vendors/put_vendors_by_id	Update a vendor	id (integer) required data: { . name (string) . description (string) . contact_name (string) . email (string) . mobile (string) . phone (string) . primary_contact_id (integer) . address (object) . custom_fields (object) } (object) required
vendors/delete_vendors_by_id	Delete a vendor	id (integer) required
workspaces/get_workspaces	List all workspaces/clients	page (integer) per_page (integer) query (string)
workspaces/post_workspaces	Create a workspace/client	data: { . name (string) . description (string) . custom_fields (object) } (object) required
workspaces/get_workspaces_by_id	View a workspace/client	id (integer) required
workspaces/put_workspaces_by_id	Update a workspace/client	id (integer) required data: { . name (string) . description (string) . custom_fields (object) } (object) required
workspaces/delete_workspaces_by_id	Delete a workspace/client	id (integer) required
workspaces/get_workspaces_fields	List all workspace/client fields	No parameters
custom	Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body.	_url (string) required _method (string) _query (object) _body _headers (object)