Atlassian Search API

openapi: 3.2.0
info:
  title: Atlassian Search API
  version: '1.0'
  description: 'Operations tagged Search across 2 of this provider''s published API definitions: bitbucket-openapi-original.yml, confluence-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.bitbucket.org/2.0
- url: //your-domain.atlassian.net
tags:
- name: Search
paths:
  /teams/{username}/search/code:
    get:
      tags:
      - Search
      summary: Atlassian Search For Code In A Team S Repositories
      description: Search for code in the repositories of the specified team.<br><br>Note that searches can match in the file's text (`content_matches`),<br>the path (`path_matches`), or both.<br><br>You can use the same syntax for the search query as in the UI.<br>E.g. to search for "foo" only within the repository "demo",<br>use the query parameter `search_query=foo+repo:demo`.<br><br>Similar to other APIs, you can request more fields using a<br>`fields` query parameter. E.g. to get some more information about<br>the repository of matched files, use the query parameter<br>`search_query=foo&fields=%2Bvalues.file.commit.repository`<br>(the `%2B` is a URL-encoded `+`).<br><br>Try `fields=%2Bvalues.*.*.*.*` to get an idea what's possible.<br>
      operationId: atlassianSearchteam
      parameters:
      - name: username
        in: path
        description: The account to search in; either the username or the UUID in curly braces
        required: true
        schema:
          type: string
      - name: search_query
        in: query
        description: The search query
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: Which page of the search results to retrieve
        required: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pagelen
        in: query
        description: How many search results to retrieve per page
        required: false
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: Successful search
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search_result_page'
              examples:
                response:
                  value:
                    size: 1
                    page: 1
                    pagelen: 10
                    query_substituted: false
                    values:
                    - type: code_search_result
                      content_match_count: 2
                      content_matches:
                      - lines:
                        - line: 2
                          segments: []
                        - line: 3
                          segments:
                          - text: 'def '
                          - text: foo
                            match: true
                          - text: '():'
                        - line: 4
                          segments:
                          - text: '    print("snek")'
                        - line: 5
                          segments: []
                      path_matches:
                      - text: src/
                      - text: foo
                        match: true
                      - text: .py
                      file:
                        path: src/foo.py
                        type: commit_file
                        links:
                          self:
                            href: https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py
        '400':
          description: 'If the search request was invalid due to one of the

            following reasons:


            * the specified type of target account doesn''''t match the actual

            account type;


            * malformed pagination properties;


            * missing or malformed search query, in the latter case an error

            key will be returned in `error.data.key` property.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Search is not enabled for the requested team, navigate to [https://bitbucket.org/search](https://bitbucket.org/search) to turn it on
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '429':
          description: Too many requests, try again later
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
    servers:
    - url: https://api.bitbucket.org/2.0
  /users/{selected_user}/search/code:
    get:
      tags:
      - Search
      summary: Atlassian Search For Code In A User S Repositories
      description: Search for code in the repositories of the specified user.<br><br>Note that searches can match in the file's text (`content_matches`),<br>the path (`path_matches`), or both.<br><br>You can use the same syntax for the search query as in the UI.<br>E.g. to search for "foo" only within the repository "demo",<br>use the query parameter `search_query=foo+repo:demo`.<br><br>Similar to other APIs, you can request more fields using a<br>`fields` query parameter. E.g. to get some more information about<br>the repository of matched files, use the query parameter<br>`search_query=foo&fields=%2Bvalues.file.commit.repository`<br>(the `%2B` is a URL-encoded `+`).<br>
      operationId: atlassianSearchaccount
      parameters:
      - name: selected_user
        in: path
        description: Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.
        required: true
        schema:
          type: string
      - name: search_query
        in: query
        description: The search query
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: Which page of the search results to retrieve
        required: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pagelen
        in: query
        description: How many search results to retrieve per page
        required: false
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: Successful search
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search_result_page'
              examples:
                response:
                  value:
                    size: 1
                    page: 1
                    pagelen: 10
                    query_substituted: false
                    values:
                    - type: code_search_result
                      content_match_count: 2
                      content_matches:
                      - lines:
                        - line: 2
                          segments: []
                        - line: 3
                          segments:
                          - text: 'def '
                          - text: foo
                            match: true
                          - text: '():'
                        - line: 4
                          segments:
                          - text: '    print("snek")'
                        - line: 5
                          segments: []
                      path_matches:
                      - text: src/
                      - text: foo
                        match: true
                      - text: .py
                      file:
                        path: src/foo.py
                        type: commit_file
                        links:
                          self:
                            href: https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py
        '400':
          description: 'If the search request was invalid due to one of the

            following reasons:


            * the specified type of target account doesn''''t match the actual

            account type;


            * malformed pagination properties;


            * missing or malformed search query, in the latter case an error

            key will be returned in `error.data.key` property.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Search is not enabled for the requested user, navigate to [https://bitbucket.org/search](https://bitbucket.org/search) to turn it on
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '429':
          description: Too many requests, try again later
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
    servers:
    - url: https://api.bitbucket.org/2.0
  /workspaces/{workspace}/search/code:
    get:
      tags:
      - Search
      summary: Atlassian Search For Code In A Workspace
      description: Search for code in the repositories of the specified workspace.<br><br>Note that searches can match in the file's text (`content_matches`),<br>the path (`path_matches`), or both.<br><br>You can use the same syntax for the search query as in the UI.<br>E.g. to search for "foo" only within the repository "demo",<br>use the query parameter `search_query=foo+repo:demo`.<br><br>Similar to other APIs, you can request more fields using a<br>`fields` query parameter. E.g. to get some more information about<br>the repository of matched files, use the query parameter<br>`search_query=foo&fields=%2Bvalues.file.commit.repository`<br>(the `%2B` is a URL-encoded `+`).<br><br>Try `fields=%2Bvalues.*.*.*.*` to get an idea what's possible.<br>
      operationId: atlassianSearchworkspace
      parameters:
      - name: workspace
        in: path
        description: The workspace to search in; either the slug or the UUID in curly braces
        required: true
        schema:
          type: string
      - name: search_query
        in: query
        description: The search query
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: Which page of the search results to retrieve
        required: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pagelen
        in: query
        description: How many search results to retrieve per page
        required: false
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: Successful search
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search_result_page'
              examples:
                response:
                  value:
                    size: 1
                    page: 1
                    pagelen: 10
                    query_substituted: false
                    values:
                    - type: code_search_result
                      content_match_count: 2
                      content_matches:
                      - lines:
                        - line: 2
                          segments: []
                        - line: 3
                          segments:
                          - text: 'def '
                          - text: foo
                            match: true
                          - text: '():'
                        - line: 4
                          segments:
                          - text: '    print("snek")'
                        - line: 5
                          segments: []
                      path_matches:
                      - text: src/
                      - text: foo
                        match: true
                      - text: .py
                      file:
                        path: src/foo.py
                        type: commit_file
                        links:
                          self:
                            href: https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py
        '400':
          description: 'If the search request was invalid due to one of the

            following reasons:


            * the specified type of target account doesn''''t match the actual

            account type;


            * malformed pagination properties;


            * missing or malformed search query, in the latter case an error

            key will be returned in `error.data.key` property.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Search is not enabled for the requested workspace, navigate to [https://bitbucket.org/search](https://bitbucket.org/search) to turn it on
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '429':
          description: Too many requests, try again later
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      x-atlassian-oauth2-scopes:
      - state: Current
        scheme: oauth2
        scopes:
        - read:repository:bitbucket
      security:
      - oauth2:
        - repository
      - basic: []
      - api_key: []
    servers:
    - url: https://api.bitbucket.org/2.0
  /wiki/rest/api/search:
    get:
      tags:
      - Search
      summary: Atlassian Search Content
      description: 'Searches for content using the<br>[Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).<br><br>**Note that CQL input queries submitted through the `/wiki/rest/api/search` endpoint no longer support user-specific fields like `user`, `user.fullname`, `user.accountid`, and `user.userkey`.** <br>See this [deprecation notice](https://developer.atlassian.com/cloud/confluence/deprecation-notice-search-api/) for more details.<br><br>Example initial call:<br>```<br>/wiki/rest/api/search?cql=type=page&limit=25<br>```<br><br>Example response:<br>```<br>{<br>  "results": [<br>    { ... },<br>    { ... },<br>    ...<br>    { ... }<br>  ],<br>  "limit": 25,<br>  "size": 25,<br>  ...<br>  "_links": {<br>    "base": "",<br>    "context": "",<br>    "next": "/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg",<br>    "self": ""<br>  }<br>}<br>```<br><br>When additional results are available, returns `next` and `prev` URLs to retrieve them in subsequent calls. The URLs each contain a cursor that points to the appropriate set of results. Use `limit` to specify the number of results returned in each call.<br><br>Example subsequent call (taken from example response):<br>```<br>/wiki/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg<br>```<br>The response to this will have a `prev` URL similar to the `next` in the example response.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission to view the entities. Note, only entities that the user has<br>permission to view will be returned.'
      operationId: atlassianSearchbycql
      parameters:
      - name: cql
        in: query
        description: 'The CQL query to be used for the search. See

          [Advanced Searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/)

          for instructions on how to build a CQL query.'
        required: true
        schema:
          type: string
      - name: cqlcontext
        in: query
        description: 'The space, content, and content status to execute the search

          against.


          - `spaceKey` Key of the space to search against. Optional.

          - `contentId` ID of the content to search against. Optional. Must be

          in the space specified by `spaceKey`.

          - `contentStatuses` Content statuses to search against. Optional.


          Specify these values in an object. For example,

          `cqlcontext={%22spaceKey%22:%22TEST%22, %22contentId%22:%22123%22}`'
        schema:
          type: string
      - name: cursor
        in: query
        description: Pointer to a set of search results, returned as part of the `next` or `prev` URL from the previous search call.
        schema:
          type: string
      - name: next
        in: query
        schema:
          type: boolean
          default: false
      - name: prev
        in: query
        schema:
          type: boolean
          default: false
      - name: limit
        in: query
        description: 'The maximum number of content objects to return per page.

          Note, this may be restricted by fixed system limits.'
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 25
      - name: start
        in: query
        description: The start point of the collection to return
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: includeArchivedSpaces
        in: query
        description: Whether to include content from archived spaces in the results.
        schema:
          type: boolean
          default: false
      - name: excludeCurrentSpaces
        in: query
        description: Whether to exclude current spaces and only show archived spaces.
        schema:
          type: boolean
          default: false
      - name: excerpt
        in: query
        description: The excerpt strategy to apply to the result
        schema:
          type: string
          default: highlight
          enum:
          - highlight
          - indexed
          - none
          - highlight_unescaped
          - indexed_unescaped
      - name: sitePermissionTypeFilter
        in: query
        description: 'Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator`

          for external/guest users, and `all` to include all permission types.'
        schema:
          type: string
          default: none
          enum:
          - all
          - externalCollaborator
          - none
      - name: _
        in: query
        schema:
          type: integer
          format: int64
      - name: expand
        in: query
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Returned if the requested results are returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchPageResponseSearchResult'
        '400':
          description: Returned if the CQL query cannot be parsed.
          content: {}
        '403':
          description: 'Returned if the calling user does not have permission to access

            Confluence.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - search:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - search:confluence
      - scheme: oAuthDefinitions
        state: Beta
        scopes:
        - read:content-details:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-connect-scope: READ
    servers:
    - url: //your-domain.atlassian.net
  /wiki/rest/api/search/user:
    get:
      tags:
      - Search
      summary: Atlassian Search Users
      description: 'Searches for users using user-specific queries from the<br>[Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).<br><br>Note that CQL input queries submitted through the `/wiki/rest/api/search/user` endpoint only support user-specific fields like `user`, `user.fullname`, `user.accountid`, and `user.userkey`.<br><br>Note that some user fields may be set to null depending on the user''s privacy settings.<br>These are: email, profilePicture, displayName, and timeZone.'
      operationId: atlassianSearchuser
      parameters:
      - name: cql
        in: query
        description: "The CQL query to be used for the search. See\n[Advanced Searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/)\nfor instructions on how to build a CQL query.\n\nExample queries:\n          cql=type=user will return all users\n          cql=user=\"1234\" will return user with accountId \"1234\"\n          You can also use IN, NOT IN, != operators\n          cql=user IN (\"12\", \"34\") will return users with accountids \"12\" and \"34\"\n          cql=user.fullname~jo will return users with nickname/full name starting with \"jo\"\n          cql=user.accountid=\"123\" will return user with accountId \"123\""
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: The starting index of the returned users.
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: 'The maximum number of user objects to return per page.

          Note, this may be restricted by fixed system limits.'
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 25
      - name: expand
        in: query
        description: 'A multi-value parameter indicating which properties of the user to expand.


          - `operations` returns the operations for the user, which are used

          when setting permissions.

          - `personalSpace` returns the personal space of the user.'
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: sitePermissionTypeFilter
        in: query
        description: 'Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator`

          for external/guest users, and `all` to include all permission types.'
        schema:
          type: string
          default: none
          enum:
          - all
          - externalCollaborator
          - none
      responses:
        '200':
          description: Returned if the requested results are returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchPageResponseSearchResult'
        '400':
          description: Returned if the CQL query cannot be parsed.
          content: {}
        '403':
          description: 'Returned if the calling user does not have permission to access

            Confluence.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:content-details:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:content-details:confluence
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: READ
    servers:
    - url: //your-domain.atlassian.net
components:
  schemas:
    commit_file:
      type: object
      title: Commit File
      description: A file object, representing a file at a commit in a repository
      properties:
        type:
          type: string
        path:
          type: string
          description: The path in the repository
        commit:
          $ref: '#/components/schemas/commit'
        attributes:
          type: string
          enum:
          - link
          - executable
          - subrepository
          - binary
          - lfs
        escaped_path:
          type: string
          description: The escaped version of the path as it appears in a diff. If the path does not require escaping this will be the same as path.
      required:
      - type
      additionalProperties: true
    search_result_page:
      type: object
      properties:
        size:
          type: integer
          format: int64
          readOnly: true
        page:
          type: integer
          format: int32
          readOnly: true
        pagelen:
          type: integer
          format: int32
          readOnly: true
        query_substituted:
          type: boolean
          readOnly: true
        next:
          type: string
          format: uri
          readOnly: true
        previous:
          type: string
          format: uri
          readOnly: true
        values:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/search_code_search_result'
    repository:
      allOf:
      - $ref: '#/components/schemas/object'
      - type: object
        title: Repository
        description: A Bitbucket repository.
        properties:
          links:
            type: object
            properties:
              self:
                type: object
                title: Link
                description: A link to a resource related to this object.
                properties:
                  href:
                    type: string
                    format: uri
                  name:
                    type: string
                additionalProperties: false
              html:
                type: object
                title: Link
                description: A link to a resource related to this object.
                properties:
                  href:
                    type: string
                    format: uri
                  name:
                    type: string
                additionalProperties: false
              avatar:
                type: object
                title: Link
                description: A link to a resource related to this object.
                properties:
                  href:
                    type: string
                    format: uri
                  name:
                    type: string
                additionalProperties: false
              pullrequests:
                type: object
                title: Link
                description: A link to a resource related to this object.
                properties:
                  href:
                    type: string
                    format: uri
                  name:
                    type: string
                additionalProperties: false
              commits:
                type: object
                title: Link
                description: A link to a resource related to this object.
                properties:
                  href:
                    type: string
                    format: uri
                  name:
                    type: string
                additionalProperties: false
              forks:
                type: object
                title: Link
                description: A link to a resource related to this object.
                properties:
                  href:
                    type: string
                    format: uri
                  name:
                    type: string
                additionalProperties: false
              watchers:
                type: object
                title: Link
                description: A link to a resource related to this object.
                properties:
                  href:
                    type: string
                    format: uri
                  name:
                    type: string
                additionalProperties: false
              downloads:
                type: object
                title: Link
                description: A link to a resource related to this object.
                properties:
                  href:
                    type: string
                    format: uri
                  name:
                    type: string
                additionalProperties: false
              clone:
                type: array
                items:
                  type: object
                  title: Link
                  description: A link to a resource related to this object.
                  properties:
                    href:
                      type: string
                      format: uri
                    name:
                      type: string
                  additionalProperties: false
              hooks:
                type: object
                title: Link
                description: A link to a resource related to this object.
                properties:
                  href:
                    type: string
                    format: uri
                  name:
                    type: string
                additionalProperties: false
            additionalProperties: false
          uuid:
            type: string
            description: The repository's immutable id. This can be used as a substitute for the slug segment in URLs. Doing this guarantees your URLs will survive renaming of the repository by its owner, or even transfer of the repository to a different user.
          full_name:
            type: string
            description: The concatenation of the repository owner's username and the slugified name, e.g. "evzijst/interruptingcow". This is the same string used in Bitbucket URLs.
          is_private:
            type: boolean
          parent:
            $ref: '#/components/schemas/repository'
          scm:
            type: string
            enum:
            - git
          owner:
            $ref: '#/components/schemas/account'
          name:
            type: string
          description:
            type: string
          created_on:
            type: string
            format: date-time
          updated_on:
            type: string
            format: date-time
          size:
            type: integer
          language:
            type: string
          has_issues:
            type: boolean
            description: '

              The issue tracker for this repository is enabled. Issue Tracker

              features are not supported for repositories in workspaces

              administered through admin.atlassian.com.

              '
          has_wiki:
            type: boolean
            description: '

              The wiki for this repository is enabled. Wiki

              features are not supported for repositories in workspaces

              administered through admin.atlassian.com.

              '
          fork_policy:
            type: string
            description: "\nControls the rules for forking this repository.\n\n* **allow_forks**: unrestricted forking\n* **no_public_forks**: restrict forking to private forks (forks cannot\n  be made public later)\n* **no_forks**: deny all forking\n"
            enum:
            - allow_forks
            - no_public_forks
            - no_forks
          project:
            $ref: '#/components/schemas/project'
          mainbranch:
            $ref: '#/components/schemas/branch'
        additionalProperties: true
    ref:
      type: object
      title: Ref
      description: A ref object, representing a branch or tag in a repository.
      properties:
        type:
          type: string
        links:
          type: object
          properties:
            self:
              type: object
              title: Link
              description: A link to a resource related to this object.
              properties:
                href:
                  type: string
                  format: uri
                name:
                  type: string
              additionalProperties: false
            commits:
              type: object
              title: Link
              description: A link to a resource related to this object.
              properties:
                href:
                  type: string
                  format: uri
                name:
                  type: string
              additionalProperties: false
            html:
              type: object
              title: Link
              description: A link to a res

# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/openapi/atlassian-search-api-openapi.yml