{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Labels API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Labels", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Labels for Content", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/label", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to be queried for its labels." }, { "name": "prefix", "value": "", "type": "query", "description": "Filters the results to labels with the specified prefix. If this parameter\nis not specified, then labels with any prefix will be returned.\n\n- `global` prefix is used by default when a user adds a label\nvia the UI.\n- `my` prefix can be explicitly added by a user when adding a label\nvia the UI, e.g. 'my:example-label'. Also, when a page is selected as\na favourite, the 'my:favourite' label is automatically added.\n- `team` can used when adding labels via [Add labels to content](#api-content-id-label-post)\nbut is not used in the UI." }, { "name": "start", "value": "", "type": "query", "description": "The starting index of the returned labels." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of labels to return per page. Note,\nthis may be restricted by fixed system limits." } ] }, "docs": "This API operation retrieves all labels that have been applied to a specific piece of Confluence content identified by its unique ID. When you make a GET request to this endpoint, it returns a collection of labels associated with the specified content, which can include both user-created labels and system-generated ones. Labels in Confluence are used for categorization, organization, and searchability of content such as pages, blog posts, and attachments. The response typically includes details " }, { "info": { "name": "Atlassian Add Labels to Content", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/label", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content that will have labels added to it." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows you to add one or more labels to a specific piece of Confluence content by making a POST request to the endpoint with the content's unique identifier. Labels are metadata tags that help organize, categorize, and improve the discoverability of pages, blog posts, and other content within Confluence. When calling this endpoint, you must provide the content ID in the URL path and include an array of label objects in the request body, specifying properties such as the label " }, { "info": { "name": "Atlassian Remove Label From Content Using Query Parameter", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/label", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content that the label will be removed from." }, { "name": "name", "value": "", "type": "query", "description": "The name of the label to be removed." } ] }, "docs": "This API operation removes a label from a specific piece of Confluence content by specifying the content ID in the URL path and the label name as a query parameter. When executed with a DELETE HTTP method, it allows users to untag or dissociate a previously applied label from a page, blog post, or other content item in Confluence. The operation requires appropriate permissions to modify labels on the target content and will return a success response once the label has been successfully removed f" }, { "info": { "name": "Atlassian Remove Label From Content", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/label/:label", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content that the label will be removed from." }, { "name": "label", "value": "", "type": "path", "description": "The name of the label to be removed." } ] }, "docs": "Removes a specific label from a Confluence content item identified by its content ID. This DELETE operation targets the endpoint /wiki/rest/api/content/{id}/label/{label} where {id} represents the unique identifier of the content (such as a page or blog post) and {label} is the name of the label to be removed. When executed successfully, the API removes the association between the specified label and the content, effectively unlabeling that content item. This operation is useful for content mana" }, { "info": { "name": "Atlassian Get All Labels", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/label", "params": [ { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." } ] }, "docs": "Returns a [paginated](#pagination) list of labels." } ] } ], "bundled": true }