Agent Skills: The Jira Cloud platform REST API

Jira Cloud platform REST API documentation. Use when working with the The Jira Cloud platform REST API or when the user needs to interact with this API.

UncategorizedID: yuyz0112/public-api-skills/the-jira-cloud-platform-rest-api

Install this agent skill to your local

pnpm dlx add-skill https://github.com/Yuyz0112/public-api-skills/tree/HEAD/apis/jira-cloud/the-jira-cloud-platform-rest-api

Skill Files

Browse the full folder contents for the-jira-cloud-platform-rest-api.

Download Skill

Loading file tree…

apis/jira-cloud/the-jira-cloud-platform-rest-api/SKILL.md

Skill Metadata

Name
the-jira-cloud-platform-rest-api
Description
Jira Cloud platform REST API documentation. Use when working with the The Jira Cloud platform REST API or when the user needs to interact with this API.

The Jira Cloud platform REST API

Jira Cloud platform REST API documentation

How to Use This Skill

This API documentation is split into multiple files for on-demand loading.

Directory structure:

references/
├── resources/      # 99 resource index files
├── operations/     # 616 operation detail files
└── schemas/        # 197 schema groups, 967 schema files

Navigation flow:

  1. Find the resource you need in the list below
  2. Read references/resources/<resource>.md to see available operations
  3. Read references/operations/<operation>.md for full details
  4. If an operation references a schema, read references/schemas/<prefix>/<schema>.md

Base URL

  • https://your-domain.atlassian.net

Authentication

Supported methods: OAuth2, basicAuth. See references/authentication.md for details.

Resources

  • Issuesreferences/resources/Issues.md (23 ops) - This resource represents Jira issues. Use it to:

  • Workflow schemesreferences/resources/Workflow-schemes.md (19 ops) - This resource represents workflow schemes. Use it

  • Workflowsreferences/resources/Workflows.md (18 ops) - This resource represents workflows. Use it to:

  • Dashboardsreferences/resources/Dashboards.md (17 ops) - This resource represents dashboards. Use it to obt
  • Issue security schemesreferences/resources/Issue-security-schemes.md (16 ops) - This resource represents issue security schemes. U
  • Issue field configurationsreferences/resources/Issue-field-configurations.md (15 ops) - This resource represents issue field configuration
  • Project versionsreferences/resources/Project-versions.md (15 ops) - This resource represents project versions. Use it
  • Field schemesreferences/resources/Field-schemes.md (14 ops) - This resource represents field schemes which are r
  • Workflow scheme draftsreferences/resources/Workflow-scheme-drafts.md (14 ops) - This resource represents draft workflow schemes. U
  • Issue custom field contextsreferences/resources/Issue-custom-field-contexts.md (13 ops) - This resource represents issue custom field contex
  • Filtersreferences/resources/Filters.md (13 ops) - This resource represents [filters](https://conflue
  • Projectsreferences/resources/Projects.md (13 ops) - This resource represents projects. Use it to get,
  • Usersreferences/resources/Users.md (13 ops) - This resource represent users. Use it to:
  • get
  • Issue type screen schemesreferences/resources/Issue-type-screen-schemes.md (11 ops) - This resource represents issue type screen schemes

  • Issue fieldsreferences/resources/Issue-fields.md (10 ops) - This resource represents issue fields, both system

  • Issue worklogsreferences/resources/Issue-worklogs.md (10 ops) - This resource represents issue worklogs. Use it to

  • Issue type schemesreferences/resources/Issue-type-schemes.md (10 ops) - This resource represents issue type schemes in cla

  • Issue bulk operationsreferences/resources/Issue-bulk-operations.md (9 ops) - This resource represents the issue bulk operations

  • Permission schemesreferences/resources/Permission-schemes.md (9 ops) - This resource represents permission schemes. Use i

  • Teams in planreferences/resources/Teams-in-plan.md (9 ops) - This resource represents planning settings for pla

  • Project rolesreferences/resources/Project-roles.md (9 ops) - This resource represents the roles that users can

  • Statusreferences/resources/Status.md (9 ops) - This resource represents statuses. Use it to searc

  • Issue attachmentsreferences/resources/Issue-attachments.md (8 ops) - This resource represents issue attachments and the

  • Project componentsreferences/resources/Project-components.md (8 ops) - This resource represents project components. Use i

  • Issue custom field options (apps)references/resources/Issue-custom-field-options-apps.md (8 ops) - This resource represents custom issue field select

  • Groupsreferences/resources/Groups.md (8 ops) - This resource represents groups of users. Use it t

  • Issue propertiesreferences/resources/Issue-properties.md (8 ops) - This resource represents [issue](#api-group-Issues

  • Issue typesreferences/resources/Issue-types.md (8 ops) - This resource represents issues types. Use it to:

  • Issue notification schemesreferences/resources/Issue-notification-schemes.md (8 ops) - This resource represents notification schemes, lis

  • Issue prioritiesreferences/resources/Issue-priorities.md (8 ops) - This resource represents issue priorities. Use it

  • Priority schemesreferences/resources/Priority-schemes.md (8 ops) - This resource represents issue priority schemes. U

  • Issue resolutionsreferences/resources/Issue-resolutions.md (8 ops) - This resource represents issue resolution values.

  • User searchreferences/resources/User-search.md (8 ops) - This resource represents various ways to search fo

  • App propertiesreferences/resources/App-properties.md (8 ops) - This resource represents app properties. Use it to

  • Avatarsreferences/resources/Avatars.md (7 ops) - This resource represents system and custom avatars

  • Issue custom field optionsreferences/resources/Issue-custom-field-options.md (7 ops) - This resource represents custom issue field select

  • Screensreferences/resources/Screens.md (7 ops) - This resource represents the screens used to recor

  • Issue searchreferences/resources/Issue-search.md (7 ops) - This resource represents various ways to search fo

  • Plansreferences/resources/Plans.md (7 ops) - This resource represents plans. Use it to get, cre

  • Issue commentsreferences/resources/Issue-comments.md (6 ops) - This resource represents issue comments. Use it to

  • Filter sharingreferences/resources/Filter-sharing.md (6 ops) - This resource represents options for sharing [filt

  • Issue remote linksreferences/resources/Issue-remote-links.md (6 ops) - This resource represents remote issue links, a way

  • JQLreferences/resources/JQL.md (6 ops) - This resource represents JQL search auto-complete

  • Myselfreferences/resources/Myself.md (6 ops) - This resource represents information about the cur

  • Project role actorsreferences/resources/Project-role-actors.md (6 ops) - This resource represents the users assigned to [pr

  • Screen tabsreferences/resources/Screen-tabs.md (6 ops) - This resource represents the screen tabs used to r

  • Time trackingreferences/resources/Time-tracking.md (5 ops) - This resource represents time tracking and time tr

  • Issue link typesreferences/resources/Issue-link-types.md (5 ops) - This resource represents [issue link](#api-group-I

  • Project templatesreferences/resources/Project-templates.md (5 ops) - This resource represents project templates. Use it

  • Project categoriesreferences/resources/Project-categories.md (5 ops) - This resource represents project categories. Use i

  • Webhooksreferences/resources/Webhooks.md (5 ops) - This resource represents webhooks. Webhooks are ca

  • Jira settingsreferences/resources/Jira-settings.md (4 ops) - This resource represents various settings in Jira.

  • Issue comment propertiesreferences/resources/Issue-comment-properties.md (4 ops) - This resource represents [issue comment](#api-grou

  • Issue watchersreferences/resources/Issue-watchers.md (4 ops) - This resource represents users watching an issue.

  • Issue worklog propertiesreferences/resources/Issue-worklog-properties.md (4 ops) - This resource represents [issue worklog](#api-grou

  • Issue type propertiesreferences/resources/Issue-type-properties.md (4 ops) - This resource represents [issue type](#api-group-I

  • Permissionsreferences/resources/Permissions.md (4 ops) - This resource represents permissions. Use it to ob

  • Project typesreferences/resources/Project-types.md (4 ops) - This resource represents project types. Use it to

  • Project avatarsreferences/resources/Project-avatars.md (4 ops) - This resource represents avatars associated with a

  • Project propertiesreferences/resources/Project-properties.md (4 ops) - This resource represents [project](#api-group-Proj

  • Project permission schemesreferences/resources/Project-permission-schemes.md (4 ops) - This resource represents permission schemes for a

  • Screen tab fieldsreferences/resources/Screen-tab-fields.md (4 ops) - This resource represents the screen tab fields use

  • Screen schemesreferences/resources/Screen-schemes.md (4 ops) - This resource represents screen schemes in classic

  • UI modifications (apps)references/resources/UI-modifications-apps.md (4 ops) - UI modifications is a feature available for **Forg

  • User propertiesreferences/resources/User-properties.md (4 ops) - This resource represents user

  • Workflow transition propertiesreferences/resources/Workflow-transition-properties.md (4 ops) - This resource represents workflow transition prope

  • Issue custom field configuration (apps)references/resources/Issue-custom-field-configuration-apps.md (3 ops) - This resource represents configurations stored aga

  • Jira expressionsreferences/resources/Jira-expressions.md (3 ops) - This resource is a collection of operations for [J

  • License metricsreferences/resources/License-metrics.md (3 ops) - This resource represents license metrics. Use it t

  • Issue votesreferences/resources/Issue-votes.md (3 ops) - This resource represents votes cast by users on an

  • Issue linksreferences/resources/Issue-links.md (3 ops) - This resource represents links between issues. Use

  • JQL functions (apps)references/resources/JQL-functions-apps.md (3 ops) - This resource represents JQL function's precomputa

  • Project classification levelsreferences/resources/Project-classification-levels.md (3 ops) - This resource represents classification levels use

  • Project key and name validationreferences/resources/Project-key-and-name-validation.md (3 ops) - This resource provides validation for project keys

  • Workflow transition rulesreferences/resources/Workflow-transition-rules.md (3 ops) - This resource represents workflow transition rules

  • Dynamic modulesreferences/resources/Dynamic-modules.md (3 ops) - This resource represents [modules registered dynam

  • App migrationreferences/resources/App-migration.md (3 ops) - This resource supports [app migrations](https://de

  • Announcement bannerreferences/resources/Announcement-banner.md (2 ops) - This resource represents an announcement banner. U

  • Issue custom field values (apps)references/resources/Issue-custom-field-values-apps.md (2 ops) - This resource represents the values of custom fiel

  • Application rolesreferences/resources/Application-roles.md (2 ops) - This resource represents application roles. Use it

  • App data policiesreferences/resources/App-data-policies.md (2 ops) - This resource represents app access rule data poli

  • Issue custom field associationsreferences/resources/Issue-custom-field-associations.md (2 ops) - This resource represents the fields associated to

  • Issue security levelreferences/resources/Issue-security-level.md (2 ops) - This resource represents issue security levels. Us

  • Project featuresreferences/resources/Project-features.md (2 ops) - This resource represents project features. Use it

  • Project emailreferences/resources/Project-email.md (2 ops) - This resource represents the email address used to

  • Issue redactionreferences/resources/Issue-redaction.md (2 ops) - This resource represents Issue Redaction. Provides

  • Issue navigator settingsreferences/resources/Issue-navigator-settings.md (2 ops) - This resource represents issue navigator settings.

  • Workflow statusesreferences/resources/Workflow-statuses.md (2 ops) - This resource represents issue workflow statuses.

  • Workflow status categoriesreferences/resources/Workflow-status-categories.md (2 ops) - This resource represents status categories. Use it

  • Tasksreferences/resources/Tasks.md (2 ops) - This resource represents a [long-running asynchron

  • Workflow scheme project associationsreferences/resources/Workflow-scheme-project-associations.md (2 ops) - This resource represents the associations between

  • Audit recordsreferences/resources/Audit-records.md (1 ops) - This resource represents audits that record activi

  • Classification levelsreferences/resources/Classification-levels.md (1 ops) - This resource represents classification levels.

  • Group and user pickerreferences/resources/Group-and-user-picker.md (1 ops) - This resource represents a list of users and a lis

  • Labelsreferences/resources/Labels.md (1 ops) - This resource represents available labels. Use it

  • Server inforeferences/resources/Server-info.md (1 ops) - This resource provides information about the Jira

  • Migration of Connect modules to Forgereferences/resources/Migration-of-Connect-modules-to-Forge.md (1 ops) - This resource supports the migration of some Conne

  • Service Registryreferences/resources/Service-Registry.md (1 ops) - This resource represents a service registry. Use i

  • restreferences/resources/rest.md (1 ops)