--- title: "Search Service Records by Specific Parameters" method: GET path: "/service-records/search" tags: ["Service Records"] --- # Search Service Records by Specific Parameters `GET /service-records/search` Search for service records based on filters, fields or customized query parameters. You can filter records using fields such as status, category, priority, assigned group or agent, creation date, and more. ## Query parameters - `fields` string[] - `query` string - `offset` integer - `limit` integer - `sort_by` string[] - `sort_dir` 'asc' | 'desc' - `expand` string[] - `filters` object ## Response `200` Matched service record entities - FlattenedCustomColumnsReadServiceRecord[] - `changeCategory` integer, nullable — The classification or severity level id of the service record (relevant only for service requests of Change type and depends on the account). - `description` string, nullable — A detailed description of the service record. - `dueDate` string, date-time, nullable — The date by which the service record is expected to be resolved. - `impact` integer, nullable — The impact level of the service record, indicating its effect on operations. - `assetId` string, nullable — The primary asset id associated with the service record. - `ciId` integer, nullable — The main configuration item (CI) id related to the service record. - `priority` integer, nullable — The priority id level of the service record. - `status` integer, nullable — The current status id of the service record (e.g., Open, Closed, Pending). Depends on an account. - `title` string — The title or subject of the service record. - `urgency` integer, nullable — The urgency level of the service record, indicating how quickly it should be addressed. - `weight` integer, nullable — A numerical value that may indicate the relative importance or complexity of the service record. - `srSubType` integer, nullable — Service record subtype. - `location` integer, nullable — Unique id of the location associated with the service record. - `custInt1` integer, nullable — Custom value 1. - `custInt2` integer, nullable — Custom value 1. - `custDate1` string, date-time, nullable — Custom date 1. - `custDate2` string, date-time, nullable — Custom date 1. - `custNotes` string, nullable — Custom notes. - `custText1` string, nullable — Custom text 1. - `custText2` string, nullable — Custom text 2. - `custList1` integer, nullable — Custom list 1 integer identifier. - `custList2` integer, nullable — Custom list 1 integer identifier. - `parentLink` integer, nullable - `workaround` string, nullable - `taskId` integer, nullable - `projectId` integer, nullable - `version` integer, nullable - `successRating` integer, nullable - `followupText` string, nullable - `followupActualDate` string, date-time, nullable - `followupPlannedDate` string, date-time, nullable - `cc` string, nullable - `id` number, nullable — Service record identifier. - `srType` integer, nullable — Type id of the service record: 1 - incident; 4 - change; 6 - problem; 10 - request; - `agreement` integer, nullable — The agreement or contract associated with the service record. - `categoryId` integer, nullable — The category id of the service record (e.g., Hardware, Software, Network). - `insertTime` string, date-time, nullable — The time indicating when the service record was created. - `updateTime` string, date-time, nullable — The timestamp indicating when the service record was updated. - `closeTime` string, date-time, nullable — The timestamp indicating when the service record was closed. - `company` union — The company or client id associated with the service record. - integer - Company - `name` string, nullable — Name of the company. - `address` string, nullable — Main company address. - `address2` string, nullable — Additional company address. - `city` string, nullable — The city in which the company is located. - `state` string, nullable — The state in which the company is located. - `zip` string, nullable — The company's zip code. - `country` string, nullable — The country in which the company is located. - `phone` string, nullable — The company’s phone number. - `fax` string, nullable — The company’s fax number. - `notes` string, nullable — Notes related to the company. - `emailAccount` string, nullable — Default email account. - `expirationDate` string, date, nullable — The date when the company's access to the help will expire. - `agreementId` integer, nullable — The ID of the SLA applied to the company. - `agreementStartDate` string, date, nullable — The start date of your service agreement with the company. - `agreementEndDate` string, date, nullable — The end date of your service agreement with the company. - `customFields` object — Company custom fields. - `version` integer, required — The latest retrievable version of the company and its details. - `id` integer, required — The unique identifier of the company in SysAid. - `currentSupportLevel` integer, nullable — The current support level assigned to the service record. - `maxSupportLevel` integer, nullable — Maximum support level that can be assigned to the service record. - `department` integer, nullable — The department id responsible for handling the service record. - `solution` string, nullable — Details of the solution applied to the service record. - `resolution` string, nullable — Details of the resolution applied to the service record. - `templateId` number, nullable — The ticket template applied to the service record. - `closureInformation` integer, nullable — Closure status of the service record. - `emailAccount` string, nullable — Account email. - `surveyStatus` integer, nullable - `reopenCounter` integer, nullable - `escalation` integer, nullable - `source` integer, nullable - `timer1` integer, nullable - `timer2` integer, nullable - `timer3` integer, nullable - `timer4` integer, nullable - `timer5` integer, nullable - `timer6` integer, nullable - `timer7` integer, nullable - `timer8` integer, nullable - `timer9` integer, nullable - `timer10` integer, nullable - `category` CategoryEntity - `id` integer — Unique id of the category entity - `primaryCategory` CategoryItem - `id` integer — Unique category key id - `name` string — Category name - `secondaryCategory` CategoryItem - `id` integer — Unique category key id - `name` string — Category name - `thirdLevelCategory` CategoryItem - `id` integer — Unique category key id - `name` string — Category name - `ci` CI - `id` integer — Unique identifier of the CI. - `name` string — Name of the CI. - `asset` Asset - `name` string — The name of the asset. - `type` string, nullable — The asset type (Laptop / Smartphone / etc.). - `source` string, nullable — The origin of the asset, describing how it was added to the system. - `manufacturer` string, nullable — The manufacturer of the asset. - `model` string, nullable — The model of the asset. - `serial` string, nullable — The asset's serial number according to the manufacturer. - `description` string, nullable — The description of the asset. - `isDisabled` boolean — Indicates whether the asset is disabled. When true, automatic inventory updates, monitoring, and all other SysAid Agent capabilities are turned off for the asset. - `ownerId` number, nullable — The unique ID of the user who owns the asset. - `ownership` 'personal' | 'company', nullable — Defines who is the official owner of the asset - the employee or the company. - `companyId` number, nullable — The unique ID of the company the asset belongs to. - `locationId` number, nullable — The unique ID of the asset’s location. - `departmentId` number, nullable — The unique ID of the department the asset belongs to. - `warrantyExpiration` string, date, nullable — The date when the asset’s warranty expires. - `patchManagementEnabled` boolean — Indicates if patch management is enabled for the asset. To learn more, see SysAid Patch Management Guide. - `os` OperatingSystem, nullable — Operating System properties. - `name` string, nullable — The name of the Operating System. - `version` string, nullable — The version of the Operating System. - `network` Network, nullable — Network properties. - `macAddresses` string[] — The MAC addresses that belong to the asset. - `ipAddresses` string[] — The IP addresses of the asset. - `customFields` FlattenedCustomColumnsFields - `additionalData` string, nullable — Additional data available for the asset. - `id` string — The asset’s unique ID within SysAid. Cannot be changed. - `updateTime` string, date-time, nullable — The timestamp of when the asset was last updated in SysAid in ISO‑8601 format. - `version` number, nullable — The asset object version. Cannot be changed. - `primaryCategory` string, nullable — First level service record category name. - `secondaryCategory` string, nullable — Second level service record category name. - `thirdLevelCategory` string, nullable — Third level service record category name. - `assignedGroup` integer, nullable — The id of the administrative group responsible for managing the service record. - `assignee` integer, nullable — The user's id to whom the service record is assigned. - `requestUser` union — The user's id who originally requested the service record. - EndUser - `firstName` string — The user's first name. - `lastName` string — The user's last name. - `displayName` string — The user's display name - `userEmail` string — The user's email address. - `isDisabled` boolean — Indicates if the user is disabled - `companyId` number, nullable — Unique ID of the company the user works for - `departmentId` number, nullable — Unique ID of the department the user belongs to - `locationId` number, nullable — Unique ID of the location associated with the user - `timezone` string — The time zone of the user - `language` string — The language used by the user (default is "en") - `workPhone` string — User's work phone number/extension - `mobile` string — User's mobile number - `receiveSRNotifications` boolean — Enable or disable automatic SR email notifications - `enablePortalLogin` boolean — Enable login to the End User Portal - `managerId` integer - `supervisorLevel` 'none' | 'department' | 'company' — Enable the user to have access to other's ssp tickets - `jobTitle` string, nullable — User's job title - `customColumnsFields` FlattenedCustomColumnsFields - `userName` string — The name of the user as provided by the SysAdmin - `company` Company - `name` string, nullable — Name of the company. - `address` string, nullable — Main company address. - `address2` string, nullable — Additional company address. - `city` string, nullable — The city in which the company is located. - `state` string, nullable — The state in which the company is located. - `zip` string, nullable — The company's zip code. - `country` string, nullable — The country in which the company is located. - `phone` string, nullable — The company’s phone number. - `fax` string, nullable — The company’s fax number. - `notes` string, nullable — Notes related to the company. - `emailAccount` string, nullable — Default email account. - `expirationDate` string, date, nullable — The date when the company's access to the help will expire. - `agreementId` integer, nullable — The ID of the SLA applied to the company. - `agreementStartDate` string, date, nullable — The start date of your service agreement with the company. - `agreementEndDate` string, date, nullable — The end date of your service agreement with the company. - `customFields` object — Company custom fields. - `version` integer, required — The latest retrievable version of the company and its details. - `id` integer, required — The unique identifier of the company in SysAid. - `groups` Group[] - `name` string, required — The group's name. - `type` 'general' | 'administrators' | 'end-users', required — The group type. - `supportLevel` integer — A number representing the support level (from existing support levels). - `companyId` integer, nullable — The unique identifier for the company associated with the group. - `email` string, email — The email address associated with the group. - `receiveAutomaticSrEmailNotifications` boolean — Indicates whether the group receives automatic SR email notifications. - `canBeAssignedToServiceRecord` boolean — Indicates if the group can be assigned to a service record. Not applicable if `type` is set to `END_USERS`. - `enableAutomaticDispatchOfServiceRecords` boolean — Determines if service records should be automatically dispatched. Only applicable if `canBeAssignedToServiceRecord` is `true` - `id` integer, required — The unique identifier of the group. - `version` integer — The version number of the resource used for optimistic locking. This value must be provided when updating a resource to prevent conflicts caused by concurrent modifications. If the provided version does not match the current version on the server, the update will be rejected to ensure data consistency. - `id` integer — The user's unique ID within SysAid - integer - `followupUser` integer, nullable — A user's id who follows up the service record's changes. - `responsibleManager` integer, nullable — Admin who manages the service record. - `submitUser` integer, nullable — The user's id who submitted the service record. - `updateUser` integer, nullable — The user's id who updated the service record. - `requestUserManager` integer, nullable — The user's id who is a manager of the user requested the service record. ## Other responses - `400` — The request was invalid or cannot be served - `401` — Authentication information is missing or invalid --- [API](https://skmtc.net/sysaid/apis/sysaid-public-api.md) · [All operations](https://skmtc.net/sysaid/apis/sysaid-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sysaid/sysaid-public-api/revisions/38a43a1b2981/schema)