Create Filter

POST {{baseUrl}}/rest/api/3/filter?expand=<string>

Creates a filter. The filter is shared according to the default share scope. The filter is not selected as a favorite.

Permissions required: Permission to access Jira.

Request Params

Key	Datatype	Required	Description
`expand`	string		Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:

sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000].
subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. |

Request Body

{"name"=>"<string>", "description"=>"<string>", "jql"=>"<string>", "favourite"=>"<boolean>", "sharePermissions"=>[{"type"=>"<string>", "project"=>{"id"=>"<string>", "email"=>"<string>", "favourite"=>"<boolean>"}, "role"=>{"name"=>"<string>", "translatedName"=>"<string>", "currentUserRole"=>"<boolean>"}, "group"=>{"name"=>"<string>"}}, {"type"=>"<string>", "project"=>{"id"=>"<string>", "email"=>"<string>", "favourite"=>"<boolean>"}, "role"=>{"name"=>"<string>", "translatedName"=>"<string>", "currentUserRole"=>"<boolean>"}, "group"=>{"name"=>"<string>"}}]}

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string

RESPONSES

status: OK

{&quot;self&quot;:&quot;https://your-domain.atlassian.net/rest/api/3/filter/10000&quot;,&quot;id&quot;:&quot;10000&quot;,&quot;name&quot;:&quot;All Open Bugs&quot;,&quot;description&quot;:&quot;Lists all open bugs&quot;,&quot;owner&quot;:{&quot;self&quot;:&quot;https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g&quot;,&quot;key&quot;:&quot;&quot;,&quot;accountId&quot;:&quot;5b10a2844c20165700ede21g&quot;,&quot;name&quot;:&quot;&quot;,&quot;avatarUrls&quot;:{&quot;48x48&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48\u0026s=48&quot;,&quot;24x24&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24\u0026s=24&quot;,&quot;16x16&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16\u0026s=16&quot;,&quot;32x32&quot;:&quot;https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32\u0026s=32&quot;},&quot;displayName&quot;:&quot;Mia Krystof&quot;,&quot;active&quot;:false},&quot;jql&quot;:&quot;type = Bug and resolution is empty&quot;,&quot;viewUrl&quot;:&quot;https://your-domain.atlassian.net/issues/?filter=10000&quot;,&quot;searchUrl&quot;:&quot;https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty&quot;,&quot;favourite&quot;:true,&quot;favouritedCount&quot;:0,&quot;sharePermissions&quot;:[],&quot;subscriptions&quot;:{&quot;size&quot;:0,&quot;items&quot;:[],&quot;max-results&quot;:0,&quot;start-index&quot;:0,&quot;end-index&quot;:0}}