How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Atlassian Filters API

The Filters API from Atlassian — 8 operation(s) for filters.

Atlassian Filters API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include Filters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 13 operations across 8 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77.

Requests are made against a single base URL, https://your-domain.atlassian.net.

13 operations 8 paths 41 schemas 3 DELETE5 GET1 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
Server
https://your-domain.atlassian.net
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Atlassian Filters API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 183 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 13

Across 8 paths, the API surfaces 13 operations — 3 DELETE, 5 GET, 1 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Filters 13

This resource represents [filters](https://confluence.atlassian.com/x/eQiiLQ). Use it to get, create, update, or delete filters. Also use it to configure the columns for a filter…

POST
/rest/api/3/filter
Atlassian Create Filter
atlassianCreatefilter 2 params body → 200400401
GET
/rest/api/3/filter/favourite
Atlassian Get Favorite Filters
atlassianGetfavouritefilters 1 param → 200401
GET
/rest/api/3/filter/my
Atlassian Get My Filters
atlassianGetmyfilters 2 params → 200401
GET
/rest/api/3/filter/search
Atlassian Search For Filters
atlassianGetfilterspaginated 12 params → 200400401
DELETE
/rest/api/3/filter/{id}
Atlassian Delete Filter
atlassianDeletefilter 1 param → 204400401
GET
/rest/api/3/filter/{id}
Atlassian Get Filter
atlassianGetfilter 3 params → 200400401
PUT
/rest/api/3/filter/{id}
Atlassian Update Filter
atlassianUpdatefilter 3 params body → 200400401
DELETE
/rest/api/3/filter/{id}/columns
Atlassian Reset Columns
atlassianResetcolumns 1 param → 204400401
GET
/rest/api/3/filter/{id}/columns
Atlassian Get Columns
atlassianGetcolumns 1 param → 200400401404
PUT
/rest/api/3/filter/{id}/columns
Atlassian Set Columns
atlassianSetcolumns 1 param body → 200400403
DELETE
/rest/api/3/filter/{id}/favourite
Atlassian Remove Filter As Favorite
atlassianDeletefavouriteforfilter 2 params → 200400
PUT
/rest/api/3/filter/{id}/favourite
Atlassian Add Filter As Favorite
atlassianSetfavouriteforfilter 2 params → 200400
PUT
/rest/api/3/filter/{id}/owner
Atlassian Change Filter Owner
atlassianChangefilterowner 1 param body → 204400403404

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are Project (34 properties), Version (19 properties), ProjectComponent (16 properties), FilterDetails (15 properties). Each schema is shown below with its type and property counts.

UserBeanAvatarUrls
object
4 properties
ColumnItem
object
Details of an issue navigator column item.
2 properties
ProjectPermissions
object
Permissions which a user has on a project.
1 property
Scope
object
The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
2 properties
ProjectRoleUser
object
Details of the user associated with the role.
1 property
UpdatedProjectCategory
object
A project category.
4 properties
ColumnRequestBody
object
1 property
ProjectRoleGroup
object
Details of the group associated with the role.
3 properties
SimplifiedHierarchyLevel
object
9 properties
Project
object
Details about a project.
34 properties
ProjectInsight
object
Additional details about a project.
2 properties
SimpleLink
object
Details about the operations available in this version.
7 properties
PageBeanFilterDetails
object
A page of items.
7 properties
VersionApprover
object
Contains details about a version approver.
4 properties
Filter
object
Details about a filter.
15 properties 1 required
ProjectRole
object
Details about the roles in a project.
11 properties
ErrorCollection
object
Error messages from an operation.
3 properties
GroupName
object
Details about a group.
3 properties
VersionIssuesStatus
object
Counts of the number of issues in various statuses.
4 properties
Hierarchy
object
The project issue type hierarchy.
2 properties
SimpleListWrapperGroupName
object
5 properties
ListWrapperCallbackApplicationRole
object
ProjectComponent
object
Details about a project component.
16 properties
SharePermission
object
Details of a share permission for the filter.
6 properties 1 required
FilterSubscriptionsList
object
A paginated list of subscriptions to a filter.
5 properties
ProjectDetails
object
Details about a project.
8 properties
ApplicationRole
object
Details of an application role.
14 properties
User
object
A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: User record deleted from Atlassian: T…
14 properties
FilterDetails
object
Details of a filter.
15 properties 1 required
RoleActor
object
Details about a user assigned to a project role.
7 properties
AvatarUrlsBean
object
4 properties
ChangeFilterOwner
object
The account ID of the new owner.
1 property 1 required
UserList
object
A paginated list of users sharing the filter. This includes users that are members of the groups or can browse the projects that the filter is shared with.
5 properties
ProjectCategory
object
A project category.
4 properties
FilterSubscription
object
Details of a user or group subscribing to a filter.
3 properties
ListWrapperCallbackGroupName
object
ProjectLandingPageInfo
object
11 properties
SimpleListWrapperApplicationRole
object
5 properties
IssueTypeDetails
object
Details about an issue type.
10 properties
Version
object
Details about a project version.
19 properties
UserBean
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-filters-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

This is an independent, third-party profile of Atlassian Filters API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.