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

Jira Filter sharing API

This resource represents options for sharing [filters](#api-group-Filters). Use it to get share scopes as well as add and remove share scopes from filters.

Jira Filter sharing API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Filter Sharing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 6 operations across 3 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df.

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

6 operations 3 paths 33 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
Base URL
https://your-domain.atlassian.net/rest/api/2
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

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

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

Paths & Operations 6

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

Filter Sharing 6

This resource represents options for sharing filters. Use it to get share scopes as well as add and remove share scopes from filters.

GET
/rest/api/3/filter/defaultShareScope
Get default share scope
getDefaultShareScope → 200401
PUT
/rest/api/3/filter/defaultShareScope
Set default share scope
setDefaultShareScope body → 200400401
GET
/rest/api/3/filter/{id}/permission
Get share permissions
getSharePermissions 1 param → 200401404
POST
/rest/api/3/filter/{id}/permission
Add share permission
addSharePermission 1 param body → 201400401404
DELETE
/rest/api/3/filter/{id}/permission/{permissionId}
Delete share permission
deleteSharePermission 2 params → 204401404
GET
/rest/api/3/filter/{id}/permission/{permissionId}
Get share permission
getSharePermission 2 params → 200401404

Schemas 33

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

ProjectPermissions
object
Permissions which a user has on a project.
1 property
Version
object
Details about a project version.
19 properties
ProjectRoleGroup
object
Details of the group associated with the role.
3 properties
ListWrapperCallbackGroupName
object
Hierarchy
object
The project issue type hierarchy.
2 properties
ProjectRole
object
Details about the roles in a project.
11 properties
IssueTypeDetails
object
Details about an issue type.
10 properties
SimpleLink
object
Details about the operations available in this version.
7 properties
DefaultShareScope
object
Details of the scope of the default sharing for new filters and dashboards.
1 property 1 required
SimplifiedHierarchyLevel
object
9 properties
ProjectComponent
object
Details about a project component.
16 properties
ProjectCategory
object
A project category.
4 properties
RoleActor
object
Details about a user assigned to a project role.
7 properties
SimpleListWrapperGroupName
object
5 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…
16 properties
SharePermission
object
Details of a share permission for the filter.
6 properties 1 required
UserBeanAvatarUrls
object
4 properties
Project
object
Details about a project.
34 properties
ListWrapperCallbackApplicationRole
object
ProjectRoleUser
object
Details of the user associated with the role.
1 property
ProjectInsight
object
Additional details about a project.
2 properties
ProjectLandingPageInfo
object
11 properties
AvatarUrlsBean
object
4 properties
UserBean
object
7 properties
VersionApprover
object
Contains details about a version approver.
4 properties
GroupName
object
Details about a group.
3 properties
ApplicationRole
object
Details of an application role.
14 properties
VersionIssuesStatus
object
Counts of the number of issues in various statuses.
4 properties
ProjectDetails
object
Details about a project.
8 properties
SharePermissionInputBean
object
7 properties 1 required
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
UpdatedProjectCategory
object
A project category.
4 properties
SimpleListWrapperApplicationRole
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-filter-sharing-api-openapi.yml Raw ↑

Other APIs Jira publishes across the network.

Jira Cloud Platform REST API v2
Jira Service Management Operations REST API
Jira Align REST API
Jira Customer Service Management REST API
Jira Issue Comments API
Jira Issue Priorities API
Jira Issue Search API
Jira Issue Statuses API
Jira Issue Transitions API
Jira Issue Types API
Jira Issues API
Jira Projects API
Where this information came from

This is an independent, third-party profile of Jira Filter sharing 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.