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 Search API

The Search API from Atlassian — 6 operation(s) for search.

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

This API exposes 5 operations across 5 paths, and defines 69 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.bitbucket.org/2.0, //your-domain.atlassian.net.

5 operations 5 paths 69 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
https://api.bitbucket.org/2.0
//your-domain.atlassian.net
Authentication
HTTP Basic, OAuth 2.0, API Key, HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 5

Atlassian Search API declares 5 security schemes for authenticating requests. It accepts HTTP basic authentication (basic). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 24 scopes. An API key is passed in the header as Authorization (api_key). It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (oAuthDefinitions) using the authorizationCode flow, exposing 73 scopes.

  • basic — Basic HTTP Authentication as per [RFC-2617](https://tools.ietf.org/html/rfc2617) (Digest not supported). Note that Basic Auth is available only with username a…
  • oauth2 — OAuth 2 as per [RFC-6749](https://tools.ietf.org/html/rfc6749).
  • api_key — API Keys can be used as Basic HTTP Authentication credentials and provide a substitute for the account's actual username and password. API Keys are only availa…
  • basicAuth — You can access this resource via basic auth.
  • oAuthDefinitions — This API uses OAuth 2 with the authorizationCode grant flow.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

Search 5
GET
/teams/{username}/search/code
Atlassian Search For Code In A Team S Repositories
atlassianSearchteam 4 params → 200400404429
GET
/users/{selected_user}/search/code
Atlassian Search For Code In A User S Repositories
atlassianSearchaccount 4 params → 200400404429
GET
/workspaces/{workspace}/search/code
Atlassian Search For Code In A Workspace
atlassianSearchworkspace 4 params → 200400404429
GET
/wiki/rest/api/search
Atlassian Search Content
atlassianSearchbycql 13 params → 200400403
GET
/wiki/rest/api/search/user
Atlassian Search Users
atlassianSearchuser 5 params → 200400403

Schemas 69

The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are Content (20 properties), Space (17 properties), User (17 properties), ScreenLookAndFeel (15 properties). Each schema is shown below with its type and property counts.

commit_file
object
A file object, representing a file at a commit in a repository
5 properties 1 required
search_result_page
object
7 properties
repository
ref
object
A ref object, representing a branch or tag in a repository.
4 properties 1 required
search_code_search_result
object
5 properties
error
object
Base type for most resource objects. It defines the common type element that identifies an object's type. It also identifies the element as Swagger's discrimin…
2 properties 1 required
account_links
object
Links related to an Account.
1 property
author
base_commit
participant
project
search_content_match
object
1 property
commit
search_line
object
2 properties
link
object
A link to a resource related to this object.
2 properties
branch
team
account
search_segment
object
2 properties
object
object
Base type for most resource objects. It defines the common type element that identifies an object's type. It also identifies the element as Swagger's discrimin…
1 property 1 required
team_links
ContentLookAndFeel
object
4 properties
GenericAccountId
stringnull
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
ContentBody
object
7 properties 2 required
HeaderLookAndFeel
object
5 properties 5 required
ContentArray
object
5 properties 3 required
SearchFieldLookAndFeel
objectnull
2 properties 2 required
ButtonLookAndFeel
objectnull
2 properties 2 required
GenericUserKey
stringnull
This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/dep…
ScreenLookAndFeel
object
15 properties 1 required
HorizontalHeaderLookAndFeel
object
5 properties 2 required
Embeddable
object
Breadcrumb
object
3 properties 3 required
Icon
objectnull
This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting.
4 properties 4 required
SpaceSettings
objectnull
4 properties 2 required
ContentRestriction
object
5 properties 3 required
ContentChildren
object
5 properties
Group
object
4 properties 3 required
TopNavigationLookAndFeel
object
3 properties 1 required
SuperBatchWebResources
object
4 properties
UsersUserKeys
objectnull
3 properties 1 required
GenericUserName
stringnull
This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/dep…
Label
object
4 properties 4 required
Content
objectnull
Base object for all content types.
20 properties 2 required
Space
objectnull
17 properties 6 required
SearchPageResponseSearchResult
object
9 properties 8 required
Theme
object
5 properties 1 required
Container
objectnull
Container for content. This can be either a space (containing a page or blogpost) or a page/blog post (containing an attachment or comment)
LookAndFeel
object
8 properties 6 required
EmbeddedContent
object
3 properties
GroupArray
object
4 properties 4 required
OperationCheckResult
object
An operation and the target entity that it applies to, e.g. create page.
2 properties 2 required
LabelArray
object
5 properties 2 required
SpaceDescription
object
3 properties 3 required
MenusLookAndFeel
object
2 properties 2 required
User
objectnull
17 properties 1 required
SpacePermission
object
This object represents a permission for given space. Permissions consist of at least one operation object with an accompanying subjects object. The following c…
5 properties 3 required
ContentHistory
objectnull
11 properties 1 required
GenericLinks
object
ContentMetadata
object
Metadata object for page, blogpost, comment content
4 properties
WebResourceDependencies
object
6 properties
ContainerSummary
object
2 properties 2 required
UserDetails
object
2 properties
ContainerLookAndFeel
objectnull
12 properties 6 required
SearchResult
object
14 properties 7 required
Version
objectnull
14 properties 3 required
ContentChildType
object
Shows whether a piece of content has attachments, comments, or child pages/whiteboards. Note, this doesn't actually contain the child objects.
4 properties
UserArray
object
6 properties 1 required
NavigationLookAndFeel
objectnull
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-search-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 Search 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.