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 Filter Sharing API

The Filter Sharing API from Atlassian — 3 operation(s) for filter sharing.

Atlassian Filter Sharing 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 Filter Sharing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

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-67b5c6e5f3598d7ec1649016d026468ab2838a77.

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-67b5c6e5f3598d7ec1649016d026468ab2838a77
Server
https://your-domain.atlassian.net
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Atlassian Filter Sharing 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 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](api-group-Filters). Use it to get share scopes as well as add and remove share scopes from filters.

GET
/rest/api/3/filter/defaultShareScope
Atlassian Get Default Share Scope
atlassianGetdefaultsharescope → 200401
PUT
/rest/api/3/filter/defaultShareScope
Atlassian Set Default Share Scope
atlassianSetdefaultsharescope body → 200400401
GET
/rest/api/3/filter/{id}/permission
Atlassian Get Share Permissions
atlassianGetsharepermissions 1 param → 200401404
POST
/rest/api/3/filter/{id}/permission
Atlassian Add Share Permission
atlassianAddsharepermission 1 param body → 201400401404
DELETE
/rest/api/3/filter/{id}/permission/{permissionId}
Atlassian Delete Share Permission
atlassianDeletesharepermission 2 params → 204401404
GET
/rest/api/3/filter/{id}/permission/{permissionId}
Atlassian Get Share Permission
atlassianGetsharepermission 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), ProjectComponent (16 properties), User (14 properties). Each schema is shown below with its type and property counts.

UserBeanAvatarUrls
object
4 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
ProjectRoleGroup
object
Details of the group associated with the role.
3 properties
SimplifiedHierarchyLevel
object
9 properties
Project
object
Details about a project.
34 properties
DefaultShareScope
object
Details of the scope of the default sharing for new filters and dashboards.
1 property 1 required
ProjectInsight
object
Additional details about a project.
2 properties
SimpleLink
object
Details about the operations available in this version.
7 properties
VersionApprover
object
Contains details about a version approver.
4 properties
SharePermissionInputBean
object
7 properties 1 required
ProjectRole
object
Details about the roles in a project.
11 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
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
RoleActor
object
Details about a user assigned to a project role.
7 properties
AvatarUrlsBean
object
4 properties
ProjectCategory
object
A project category.
4 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-filter-sharing-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 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.