Saved Queries

This resource lets you get the list of saved searches that the specific user created.

Resource	/api/users/{userID}/savedQueries
Returned entity	SavedQuery. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a List of SavedQueries.

SavedQuery attributes

Represents a saved search.

Related Resources

Below you can find the list of resources that let you work with this entity.

Extends WatchFolder

Attributes

This table describes attributes of the SavedQuery entity.

To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.
To update an attribute, provide it in the body of a POST request.

Field	Type	Description
id	String	The ID of the saved search. `Read-only`.
query	String	The query that is saved in this search. `Can be null`.
issues	Array of Issues	The collection of issues that match this saved search. `Read-only`.
visibleFor	UserGroup	Deprecated. Use the `readSharingSettings` attribute instead. Group of users that can see this saved search. If the saved search is visible only to its owner, this property is null. `Can be null`.
updateableBy	UserGroup	Deprecated. Use the `updateSharingSettings` attribute instead. Group of users that can update this saved search. If only the owner of the saved search can update it, this property is null. `Can be null`.
readSharingSettings	WatchFolderSharingSettings	Users and groups that can see this saved search. If the saved search is visible only to its owner, this property contains an empty array. `Read-only`.
updateSharingSettings	WatchFolderSharingSettings	Users and groups that can update this saved search. If only the owner of the saved search can update it, this property contains an empty array. `Read-only`.
owner	User	The user who created the watch folder. `Read-only`. `Can be null`.
name	String	The name of the issue folder. `Can be null`.

Read a List of SavedQueries

Get the list of all saved searches that this user created.

Request syntax

GET /api/users/{userID}/savedQueries?{fields}&{$top}&{$skip}

Request parameters

Parameter	Type	Description
fields	String	A list of SavedQuery attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.
$skip	Int	Optional. Lets you set a number of returned entities to skip before returning the first one.
$top	Int	Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries. The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination.

Parameter

Type

Description

fields

String

A list of SavedQuery attributes that should be returned in the response. If no field is specified, only the entityID is returned.

$skip

Int

Optional. Lets you set a number of returned entities to skip before returning the first one.

$top

Int

Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries.

The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination.

Sample

Sample request

                https://example.youtrack.cloud/api/users/1-2/savedQueries?fields=query,id,name,visibleFor(id,name),isUpdateable,owner(id,name)&$top=3
            

Sample response body

                [
                  {
                    "query": "project: RAP #Unassigned",
                    "visibleFor": null,
                    "owner": {
                      "name": "John Doe",
                      "id": "1-2",
                      "$type": "User"
                    },
                    "name": "Unassigned in RAP",
                    "id": "51-4",
                    "$type": "SavedQuery"
                  },
                  {
                    "query": "project: RP #Unassigned",
                    "visibleFor": null,
                    "owner": {
                      "name": "John Doe",
                      "id": "1-2",
                      "$type": "User"
                    },
                    "name": "Unassigned in RP",
                    "id": "51-7",
                    "$type": "SavedQuery"
                  },
                  {
                    "query": "project: GRP #Unassigned",
                    "visibleFor": null,
                    "owner": {
                      "name": "John Doe",
                      "id": "1-2",
                      "$type": "User"
                    },
                    "name": "Unassigned in GRP",
                    "id": "51-8",
                    "$type": "SavedQuery"
                  }
                ]
            

Last modified: 7 November 2024