{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account Search API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Search",
"type": "folder"
},
"items": [
{
"info": {
"name": "Atlassian Search for Code in Teams Repositories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/teams/:username/search/code",
"params": [
{
"name": "username",
"value": "",
"type": "path",
"description": "The account to search in; either the username or the UUID in curly braces"
},
{
"name": "search_query",
"value": "",
"type": "query",
"description": "The search query"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Which page of the search results to retrieve"
},
{
"name": "pagelen",
"value": "",
"type": "query",
"description": "How many search results to retrieve per page"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "This API operation allows you to search for code across all repositories belonging to a specific team in Bitbucket. By making a GET request to the endpoint with the team's username as a path parameter, you can perform code searches within the team's repository collection. The operation returns matching code snippets and their locations across the team's codebase, making it useful for finding specific code patterns, function definitions, or text strings across multiple repositories owned by the t"
},
{
"info": {
"name": "Atlassian Search for Code in Users Repositories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/users/:selected_user/search/code",
"params": [
{
"name": "selected_user",
"value": "",
"type": "path",
"description": "Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID."
},
{
"name": "search_query",
"value": "",
"type": "query",
"description": "The search query"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Which page of the search results to retrieve"
},
{
"name": "pagelen",
"value": "",
"type": "query",
"description": "How many search results to retrieve per page"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "The Atlassian Bitbucket User API endpoint `/users/{selected_user}/search/code` accessed via GET method enables developers to perform code searches across all repositories belonging to a specific user. By providing a username in the `{selected_user}` path parameter along with search query parameters, this operation scans through the code content within that user's repositories and returns matching results. This is particularly useful for finding specific code snippets, function names, variables, "
},
{
"info": {
"name": "Atlassian Search for Code in a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/search/code",
"params": [
{
"name": "workspace",
"value": "",
"type": "path",
"description": "The workspace to search in; either the slug or the UUID in curly braces"
},
{
"name": "search_query",
"value": "",
"type": "query",
"description": "The search query"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Which page of the search results to retrieve"
},
{
"name": "pagelen",
"value": "",
"type": "query",
"description": "How many search results to retrieve per page"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "This GET endpoint allows you to search for code across repositories within a specified Atlassian Bitbucket workspace. By providing the workspace identifier in the path parameter, you can perform code searches using query parameters to find specific strings, patterns, or code snippets across all accessible repositories in that workspace. The operation returns matching results that include file paths, repository information, and code context where the search terms appear, making it useful for deve"
},
{
"info": {
"name": "Atlassian Search Content by Cql",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/search",
"params": [
{
"name": "cql",
"value": "",
"type": "query",
"description": "The CQL string that is used to find the requested content."
},
{
"name": "cqlcontext",
"value": "",
"type": "query",
"description": "The space, content, and content status to execute the search against.\nSpecify this as an object with the following properties:\n\n- `spaceKey` Key of the space to search against. Optional.\n- `contentId` ID of the content to search against. Optional. Must\nbe in the space spacified by `spaceKey`.\n- `contentStatuses` Content statuses to search against. Optional."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content to expand.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment."
},
{
"name": "cursor",
"value": "",
"type": "query",
"description": "Pointer to a set of search results, returned as part of the `next` or `prev` URL from the previous search call."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of content objects to return per page.\nNote, this may be restricted by fixed system limits."
}
]
},
"docs": "This API operation allows you to search for Confluence content using the Confluence Query Language (CQL), providing a powerful and flexible way to retrieve pages, blog posts, attachments, and other content types based on specific criteria. By sending a GET request to the /wiki/rest/api/content/search endpoint with a CQL query string parameter, you can filter content by various attributes such as type, space, creator, creation date, labels, title text, or any combination of these conditions. The "
},
{
"info": {
"name": "Atlassian Search Users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/search/user",
"params": [
{
"name": "cql",
"value": "",
"type": "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\""
},
{
"name": "start",
"value": "",
"type": "query",
"description": "The starting index of the returned users."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of user objects to return per page.\nNote, this may be restricted by fixed system limits."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the user to expand.\n\n- `operations` returns the operations for the user, which are used\nwhen setting permissions.\n- `personalSpace` returns the personal space of the user."
},
{
"name": "sitePermissionTypeFilter",
"value": "",
"type": "query",
"description": "Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator`\nfor external/guest users, and `all` to include all permission types."
}
]
},
"docs": "Searches for users using user-specific queries from the
[Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
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`.
Note that some user fields may be set to null depending on the user's privacy settings.
These are: email, profilePictur"
},
{
"info": {
"name": "Atlassian Search Content",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/search",
"params": [
{
"name": "cql",
"value": "",
"type": "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."
},
{
"name": "cqlcontext",
"value": "",
"type": "query",
"description": "The space, content, and content status to execute the search\nagainst.\n\n- `spaceKey` Key of the space to search against. Optional.\n- `contentId` ID of the content to search against. Optional. Must be\nin the space specified by `spaceKey`.\n- `contentStatuses` Content statuses to search against. Optional.\n\nSpecify these values in an object. For example,\n`cqlcontext={%22spaceKey%22:%22TEST%22, %22contentId%22:%22123%22}`"
},
{
"name": "cursor",
"value": "",
"type": "query",
"description": "Pointer to a set of search results, returned as part of the `next` or `prev` URL from the previous search call."
},
{
"name": "next",
"value": "",
"type": "query"
},
{
"name": "prev",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of content objects to return per page.\nNote, this may be restricted by fixed system limits."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "The start point of the collection to return"
},
{
"name": "includeArchivedSpaces",
"value": "",
"type": "query",
"description": "Whether to include content from archived spaces in the results."
},
{
"name": "excludeCurrentSpaces",
"value": "",
"type": "query",
"description": "Whether to exclude current spaces and only show archived spaces."
},
{
"name": "excerpt",
"value": "",
"type": "query",
"description": "The excerpt strategy to apply to the result"
},
{
"name": "sitePermissionTypeFilter",
"value": "",
"type": "query",
"description": "Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator`\nfor external/guest users, and `all` to include all permission types."
},
{
"name": "_",
"value": "",
"type": "query"
},
{
"name": "expand",
"value": "",
"type": "query"
}
]
},
"docs": "Searches for content using the
[Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
**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`.**
See this [deprecation notice](https://developer.atlassian.com/cloud/confluence/deprecation-notice-search-api/) for more details.
Example in"
}
]
}
],
"bundled": true
}