Search Service Records by Specific Parameters

get

https://{account}.sysaidit.com/connect/v1/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 Params

fields

array of strings

A comma-separated list of fields to return in service records.

fields

query

string

The search criteria

offset

integer

SR count is limited (see limit parameter). This parameter specifies the offset
(start point) from which to retrieve values (e.g. 25). Defaults to 0.

limit

integer

≤ 100

Defaults to 100

The maximum number of SRs to retrieve per request. Defaults to 100 results (configurable).

sort_by

array of strings

One or more fields to sort by. Available fields are those that were fetched by the request.

sort_by

sort_dir

string

enum

Sort order: ascending or descending. Available values: asc/desc. Default is 'asc'.
Relevant only when sort parameter is sent.

Allowed:

expand

array of strings

Names of service record property to expand

filters

object

List of key-value parameters with {filter.id} as the key. and {filter.values.id} as the value.
I.e.: …&status=19&request_user=235.
Multiple values can be sent, comma-separated. I.e.: …&status=4,5.

Responses

200Matched service record entities

400The request was invalid or cannot be served

401Authentication information is missing or invalid