Jira connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Set up the connector

   Register your Jira credentials with Scalekit so it handles the token lifecycle. You do this once per environment.

   Dashboard setup steps

   Register your Scalekit environment with the Jira connector so Scalekit handles the authentication flow and token lifecycle for you. The connection name you create will be used to identify and invoke the connection programmatically. Then complete the configuration in your application as follows:

   1. Set up auth redirects

      • In Scalekit dashboard, go to AgentKit > Connections > Create Connection. Find Jira and click Create. Copy the redirect URI. It looks like https://<SCALEKIT_ENVIRONMENT_URL>/sso/v1/oauth/<CONNECTION_ID>/callback.

        

      • In the Atlassian Developer Console, open your app and go to Authorization → OAuth 2.0 (3LO) → Configure.

      • Paste the copied URI into the Callback URL field and click Save changes.

        

   2. Get client credentials

      In the Atlassian Developer Console, open your app and go to Settings:

      • Client ID — listed under Client ID
      • Client Secret — listed under Secret

   3. Add credentials in Scalekit

      • In Scalekit dashboard, go to AgentKit > Connections and open the connection you created.

      • Enter your credentials:

        • Client ID (from your Atlassian app)
        • Client Secret (from your Atlassian app)
        • Permissions (scopes — see Jira OAuth scopes reference)

        

      • Click Save.

4. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'jira'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Jira:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'jira_all_users_default_list',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "jira"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Jira:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="jira_all_users_default_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• Read issues — fetch issue details, comments, attachments, and linked items
• Create and update issues — file bugs, stories, and tasks; update status and assignees
• Manage projects — list projects, sprints, and boards
• Search with JQL — execute Jira Query Language searches for advanced filtering

Common workflows

Don’t worry about the Jira cloud ID in the path. Scalekit resolves {{cloud_id}} from the connected account configuration automatically. A request with path="/rest/api/3/myself" is routed to the correct Atlassian instance without any extra setup.

Proxy API call

Node.js

// Fetch the authenticated user's Jira profile
const me = await actions.request({
  connectionName: 'jira',
  identifier: 'user_123',
  path: '/rest/api/3/myself',
  method: 'GET',
});
console.log(me);

Python

# Fetch the authenticated user's Jira profile
me = actions.request(
    connection_name="jira",
    identifier="user_123",
    path="/rest/api/3/myself",
    method="GET"
)
print(me)

No OAuth flow per request

Jira uses OAuth 2.0 — Scalekit stores and refreshes the access token automatically. Your code only needs connection_name and identifier per request.

Get the current user

Node.js

const me = await actions.executeTool({
  connector: 'jira',
  identifier: 'user_123',
  toolName: 'jira_myself_get',
  toolInput: {},
});
console.log(me.accountId, me.displayName);

Python

me = actions.execute_tool(
    connection_name="jira",
    identifier="user_123",
    tool_name="jira_myself_get",
    tool_input={}
)
print(me["accountId"], me["displayName"])

Advanced enrichment workflow

This example shows a complete Jira issue triage pipeline: search open bugs assigned to the current user, log triage time, transition issues to “In Progress”, create follow-up tasks, and link them — all in one automated flow.

Node.js

const opts = { connector: 'jira', identifier: 'user_123' };

async function triageMyBugs(projectKey: string) {
  // 1. Get the current user's account ID
  const me = await actions.executeTool({
    toolName: 'jira_myself_get',
    ...opts,
    toolInput: {},
  });
  console.log(`Triaging bugs for: ${me.displayName}`);

  // 2. Search for open bugs assigned to the current user
  const searchResult = await actions.executeTool({
    toolName: 'jira_issues_search',
    ...opts,
    toolInput: {
      jql: `project = ${projectKey} AND issuetype = Bug AND assignee = currentUser() AND status = "To Do" ORDER BY priority DESC`,
      maxResults: 10,
      fields: 'summary,status,priority,issuetype',
    },
  });

  const bugs = searchResult.issues ?? [];
  console.log(`Found ${bugs.length} open bugs`);

  for (const bug of bugs) {
    const issueKey = bug.key;
    console.log(`
Processing ${issueKey}: ${bug.fields.summary}`);

    // 3. Add a triage comment
    await actions.executeTool({
      toolName: 'jira_issue_comment_add',
      ...opts,
      toolInput: {
        issueIdOrKey: issueKey,
        body: `Automated triage: picking up for sprint. Moving to In Progress.`,
      },
    });

    // 4. Log 30 minutes of triage work
    await actions.executeTool({
      toolName: 'jira_issue_worklog_add',
      ...opts,
      toolInput: {
        issueIdOrKey: issueKey,
        timeSpent: '30m',
        comment: 'Initial triage and review',
      },
    });

    // 5. Get available transitions and move to "In Progress"
    const transitions = await actions.executeTool({
      toolName: 'jira_issue_transitions_list',
      ...opts,
      toolInput: { issueIdOrKey: issueKey },
    });

    const inProgress = transitions.transitions?.find(
      (t: any) => t.name.toLowerCase().includes('progress')
    );

    if (inProgress) {
      await actions.executeTool({
        toolName: 'jira_issue_transition',
        ...opts,
        toolInput: {
          issueIdOrKey: issueKey,
          transitionId: inProgress.id,
          comment: 'Starting work on this bug.',
        },
      });
      console.log(`  → Transitioned to "${inProgress.name}"`);
    }

    // 6. Create a linked follow-up task for the fix
    const followUp = await actions.executeTool({
      toolName: 'jira_issue_create',
      ...opts,
      toolInput: {
        project_key: projectKey,
        summary: `[Fix] ${bug.fields.summary}`,
        issue_type: 'Task',
        description: `Follow-up fix task for bug ${issueKey}.`,
        assignee_account_id: me.accountId,
        priority_name: bug.fields.priority?.name ?? 'Medium',
      },
    });
    console.log(`  → Created follow-up: ${followUp.key}`);

    // 7. Link the bug to its follow-up task
    await actions.executeTool({
      toolName: 'jira_issue_link_create',
      ...opts,
      toolInput: {
        link_type_name: 'Relates',
        inward_issue_key: issueKey,
        outward_issue_key: followUp.key,
      },
    });
  }

  console.log('\nTriage complete.');
}

triageMyBugs('MYPROJECT').catch(console.error);

Python

def execute(tool_name, tool_input):
    return actions.execute_tool(
        connection_name="jira",
        identifier="user_123",
        tool_name=tool_name,
        tool_input=tool_input
    )

def triage_my_bugs(project_key: str):
    # 1. Get the current user's account ID
    me = execute("jira_myself_get", {})
    print(f"Triaging bugs for: {me['displayName']}")

    # 2. Search for open bugs assigned to current user
    search_result = execute("jira_issues_search", {
        "jql": f'project = {project_key} AND issuetype = Bug AND assignee = currentUser() AND status = "To Do" ORDER BY priority DESC',
        "maxResults": 10,
        "fields": "summary,status,priority,issuetype"
    })

    bugs = search_result.get("issues", [])
    print(f"Found {len(bugs)} open bugs")

    for bug in bugs:
        issue_key = bug["key"]
        print(f"\nProcessing {issue_key}: {bug['fields']['summary']}")

        # 3. Add a triage comment
        execute("jira_issue_comment_add", {
            "issueIdOrKey": issue_key,
            "body": "Automated triage: picking up for sprint. Moving to In Progress."
        })

        # 4. Log 30 minutes of triage work
        execute("jira_issue_worklog_add", {
            "issueIdOrKey": issue_key,
            "timeSpent": "30m",
            "comment": "Initial triage and review"
        })

        # 5. Get transitions and move to "In Progress"
        transitions = execute("jira_issue_transitions_list", {"issueIdOrKey": issue_key})
        in_progress = next(
            (t for t in transitions.get("transitions", [])
             if "progress" in t["name"].lower()),
            None
        )
        if in_progress:
            execute("jira_issue_transition", {
                "issueIdOrKey": issue_key,
                "transitionId": in_progress["id"],
                "comment": "Starting work on this bug."
            })
            print(f"  → Transitioned to \"{in_progress['name']}\"")

        # 6. Create a linked follow-up task
        follow_up = execute("jira_issue_create", {
            "project_key": project_key,
            "summary": f"[Fix] {bug['fields']['summary']}",
            "issue_type": "Task",
            "description": f"Follow-up fix task for bug {issue_key}.",
            "assignee_account_id": me["accountId"],
            "priority_name": bug["fields"].get("priority", {}).get("name", "Medium")
        })
        print(f"  → Created follow-up: {follow_up['key']}")

        # 7. Link the bug to its follow-up task
        execute("jira_issue_link_create", {
            "link_type_name": "Relates",
            "inward_issue_key": issue_key,
            "outward_issue_key": follow_up["key"]
        })

    print("\nTriage complete.")

triage_my_bugs("MYPROJECT")

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

jira_agile_issue_estimation_get#Retrieve the estimation value of an issue for a specific board, along with the fieldId of the field used for estimation on that board (e.g. story points or original time estimate). The boardId is required to determine which field is used for estimation.2 params▾

Retrieve the estimation value of an issue for a specific board, along with the fieldId of the field used for estimation on that board (e.g. story points or original time estimate). The boardId is required to determine which field is used for estimation.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board required to determine which field is used for estimation. Returns 400 if not provided.

issueIdOrKeystringrequiredThe ID or key of the requested issue

jira_agile_issue_estimation_set#Update the estimation value of an issue for a specific board (e.g. story points or original time estimate, depending on the board's configured estimation field). The boardId is required to determine which field is used for estimation. Returns the new estimation value and the fieldId of the field that was updated.3 params▾

Update the estimation value of an issue for a specific board (e.g. story points or original time estimate, depending on the board's configured estimation field). The boardId is required to determine which field is used for estimation. Returns the new estimation value and the fieldId of the field that was updated.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board required to determine which field is used for estimation. Returns 400 if not provided.

issueIdOrKeystringrequiredThe ID or key of the requested issue

valuestringrequiredThe new estimation value for the issue on this board, as a string (e.g. story points value or time estimate depending on the board's configured field)

jira_agile_issue_get#Retrieve details of a Jira issue by its ID or key using the Jira Software Agile API. Returns fields, status, assignee, priority, and other navigable and Agile-specific metadata (e.g. sprint, epic, estimation). Use the fields parameter to limit the response to specific fields, and expand to include additional data such as changelog.4 params▾

Retrieve details of a Jira issue by its ID or key using the Jira Software Agile API. Returns fields, status, assignee, priority, and other navigable and Agile-specific metadata (e.g. sprint, epic, estimation). Use the fields parameter to limit the response to specific fields, and expand to include additional data such as changelog.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID (e.g. 10001) or key (e.g. PROJ-123) to retrieve

expandstringoptionalComma-separated list of additional data to include (e.g. renderedFields,names,changelog,transitions,operations,editmeta,versionedRepresentations)

fieldsstringoptionalComma-separated list of fields to return (use * for all navigable fields, or -field to exclude a field). By default all navigable and Agile fields are returned.

updateHistorybooleanoptionalA boolean indicating whether the issue retrieved by this method should be added to the current user's issue history

jira_agile_issue_rank#Move or rank a list of Jira issues relative to another issue on the board's ranking field. Provide either rankBeforeIssue or rankAfterIssue (not both) to specify the target position; if neither is provided, the issues are moved to the last-ranked position. Returns an empty response (204) if the operation was fully successful, or a per-issue status list (207) if some issues could not be ranked.4 params▾

Move or rank a list of Jira issues relative to another issue on the board's ranking field. Provide either rankBeforeIssue or rankAfterIssue (not both) to specify the target position; if neither is provided, the issues are moved to the last-ranked position. Returns an empty response (204) if the operation was fully successful, or a per-issue status list (207) if some issues could not be ranked.

NameTypeRequiredDescription

issuesarrayrequiredThe list of issue IDs or keys to rank, in the order they should be ranked

rankAfterIssuestringoptionalThe issue ID or key after which the issues in the 'issues' list should be ranked. Do not set this if rankBeforeIssue is set.

rankBeforeIssuestringoptionalThe issue ID or key before which the issues in the 'issues' list should be ranked. Do not set this if rankAfterIssue is set.

rankCustomFieldIdintegeroptionalThe ID of the custom field representing the board's ranking. Only required if the board has multiple ranking fields configured.

jira_all_users_default_list#Returns a paginated list of all users, including active, inactive, and previously deleted users that have an Atlassian account. Privacy controls may hide fields like email address depending on user preferences. This is the default users listing endpoint (/rest/api/3/users); prefer this or the Get All Users tool interchangeably.3 params▾

Returns a paginated list of all users, including active, inactive, and previously deleted users that have an Atlassian account. Privacy controls may hide fields like email address depending on user preferences. This is the default users listing endpoint (/rest/api/3/users); prefer this or the Get All Users tool interchangeably.

NameTypeRequiredDescription

expandstringoptionalAdditional data to include in the response for each user (implementation-specific expand options).

maxResultsintegeroptionalThe maximum number of items to return per page. Limited to 1000.

startAtintegeroptionalThe index of the first item to return in a page of results (page offset), default 0.

jira_all_users_list#Returns a paginated list of all users, including active, inactive, and previously deleted users that have an Atlassian account. Privacy controls may hide fields like email address depending on user preferences. Uses the /rest/api/3/users/search endpoint.3 params▾

Returns a paginated list of all users, including active, inactive, and previously deleted users that have an Atlassian account. Privacy controls may hide fields like email address depending on user preferences. Uses the /rest/api/3/users/search endpoint.

NameTypeRequiredDescription

expandstringoptionalAdditional data to include in the response for each user (implementation-specific expand options).

maxResultsintegeroptionalThe maximum number of items to return per page. Limited to 1000.

startAtintegeroptionalThe index of the first item to return in a page of results (page offset), default 0.

jira_archived_issues_export#Request an export of archived issue details, filtered by project keys, issue type IDs, reporters, archiving user, or archived date range. Upon success, the admin who submitted the request receives an email with a link to download a CSV file. Only system fields and archival-specific fields (ArchivedBy, ArchivedDate) are exported; custom fields are not supported. Requires Jira admin or site admin global permission.6 params▾

Request an export of archived issue details, filtered by project keys, issue type IDs, reporters, archiving user, or archived date range. Upon success, the admin who submitted the request receives an email with a link to download a CSV file. Only system fields and archival-specific fields (ArchivedBy, ArchivedDate) are exported; custom fields are not supported. Requires Jira admin or site admin global permission.

NameTypeRequiredDescription

archivedByarrayoptionalList archived issues archived by the specified account IDs

dateAfterstringoptionalList issues archived after this date, in YYYY-MM-DD format. Used together with dateBefore to build the archivedDateRange filter.

dateBeforestringoptionalList issues archived before this date, in YYYY-MM-DD format. Used together with dateAfter to build the archivedDateRange filter.

issueTypesarrayoptionalList archived issues with the specified issue type IDs

projectsarrayoptionalList archived issues belonging to the specified project keys

reportersarrayoptionalList archived issues where the reporter is one of the specified account IDs

jira_attachment_add#Add a single attachment to a Jira issue. The file content must be supplied as a base64-encoded string along with a filename; it is uploaded as multipart/form-data with the required X-Atlassian-Token header. Returns metadata for the created attachment.3 params▾

Add a single attachment to a Jira issue. The file content must be supplied as a base64-encoded string along with a filename; it is uploaded as multipart/form-data with the required X-Atlassian-Token header. Returns metadata for the created attachment.

NameTypeRequiredDescription

file_content_base64stringrequiredBase64-encoded contents of the file to attach

filenamestringrequiredThe name of the file being uploaded, including extension

issueIdOrKeystringrequiredThe ID or key of the issue that the attachment is added to

jira_attachment_content_get#Download the binary contents of a Jira attachment by its ID. Optionally scope the download to a byte range using the Range header, or disable the redirect Jira normally issues to the actual file location. Use Get Attachment for metadata only, or Get Attachment Thumbnail for a scaled preview image.2 params▾

Download the binary contents of a Jira attachment by its ID. Optionally scope the download to a byte range using the Range header, or disable the redirect Jira normally issues to the actual file location. Use Get Attachment for metadata only, or Get Attachment Thumbnail for a scaled preview image.

NameTypeRequiredDescription

idstringrequiredThe ID of the attachment whose content should be downloaded.

redirectbooleanoptionalWhether a redirect is provided for the attachment download. Set to false if your client does not automatically follow redirects, to avoid multiple requests.

jira_attachment_delete#Permanently delete a Jira issue attachment by its ID. This action cannot be undone. Requires Delete Attachments project permission.1 param▾

Permanently delete a Jira issue attachment by its ID. This action cannot be undone. Requires Delete Attachments project permission.

NameTypeRequiredDescription

idstringrequiredThe attachment ID to delete

jira_attachment_expand_human_get#Get the metadata for an attachment's contents when the attachment is an archive (currently only ZIP is supported), along with metadata for the attachment itself such as its ID and name. Use this to present attachment archive contents to a user. To process the archive contents programmatically without the attachment's own metadata, use Get Expanded Attachment (Raw) instead.1 param▾

Get the metadata for an attachment's contents when the attachment is an archive (currently only ZIP is supported), along with metadata for the attachment itself such as its ID and name. Use this to present attachment archive contents to a user. To process the archive contents programmatically without the attachment's own metadata, use Get Expanded Attachment (Raw) instead.

NameTypeRequiredDescription

idstringrequiredThe ID of the attachment to expand.

jira_attachment_expand_raw_get#Get the metadata for the contents of an attachment when it is an archive (currently only ZIP is supported). Returns only the metadata for the contents of the archive, not the attachment's own metadata. Use this when processing archive contents programmatically. To retrieve data intended for display to a user, use Get Expanded Attachment (Human-Readable) instead.1 param▾

Get the metadata for the contents of an attachment when it is an archive (currently only ZIP is supported). Returns only the metadata for the contents of the archive, not the attachment's own metadata. Use this when processing archive contents programmatically. To retrieve data intended for display to a user, use Get Expanded Attachment (Human-Readable) instead.

NameTypeRequiredDescription

idstringrequiredThe ID of the attachment to expand.

jira_attachment_get#Get metadata for a Jira issue attachment by its ID. Returns the filename, MIME type, size, creation date, author, and download URL.1 param▾

Get metadata for a Jira issue attachment by its ID. Returns the filename, MIME type, size, creation date, author, and download URL.

NameTypeRequiredDescription

idstringrequiredThe attachment ID to retrieve metadata for

jira_attachment_meta_get#Get the Jira instance's attachment settings, including whether attachments are enabled and the maximum attachment size allowed. Note that project-level permissions may further restrict who can create or delete attachments.0 params▾

Get the Jira instance's attachment settings, including whether attachments are enabled and the maximum attachment size allowed. Note that project-level permissions may further restrict who can create or delete attachments.

jira_attachment_thumbnail_get#Download the thumbnail image of a Jira attachment by its ID. Optionally scale the thumbnail to a maximum width/height, fall back to a default thumbnail if the requested one isn't found, or disable the redirect Jira normally issues. Use Get Attachment Content to retrieve the full attachment instead.5 params▾

Download the thumbnail image of a Jira attachment by its ID. Optionally scale the thumbnail to a maximum width/height, fall back to a default thumbnail if the requested one isn't found, or disable the redirect Jira normally issues. Use Get Attachment Content to retrieve the full attachment instead.

NameTypeRequiredDescription

idstringrequiredThe ID of the attachment whose thumbnail should be downloaded.

fallbackToDefaultbooleanoptionalWhether a default thumbnail is returned when the requested thumbnail is not found.

heightintegeroptionalThe maximum height to scale the thumbnail to, in pixels.

redirectbooleanoptionalWhether a redirect is provided for the thumbnail download. Set to false if your client does not automatically follow redirects, to avoid multiple requests.

widthintegeroptionalThe maximum width to scale the thumbnail to, in pixels.

jira_backlog_issues_move#Move a set of Jira issues to the backlog by removing any future or active sprint assignment from them. At most 50 issues may be moved in a single call. Returns no content on success.1 param▾

Move a set of Jira issues to the backlog by removing any future or active sprint assignment from them. At most 50 issues may be moved in a single call. Returns no content on success.

NameTypeRequiredDescription

issuesarrayrequiredArray of issue ID or key strings to move to the backlog (max 50 per call). Example: ["PR-1", "PR-2", "10001"]

jira_backlog_issues_move_for_board#Move issues to the backlog of a specific board, provided the issues are already on that board. If the board has sprints, this removes any future or active sprint from the issues; if the board has no sprints, this simply returns the issues to the board's backlog. Optionally rank the moved issues before or after another issue. At most 50 issues may be moved in a single call. Returns no content on success, or a 207 multi-status body describing per-issue rank results.5 params▾

Move issues to the backlog of a specific board, provided the issues are already on that board. If the board has sprints, this removes any future or active sprint from the issues; if the board has no sprints, this simply returns the issues to the board's backlog. Optionally rank the moved issues before or after another issue. At most 50 issues may be moved in a single call. Returns no content on success, or a 207 multi-status body describing per-issue rank results.

NameTypeRequiredDescription

boardIdintegerrequiredThe numeric ID of the board whose backlog the issues will be moved to.

issuesarrayoptionalArray of issue ID or key strings to move to the board's backlog (max 50 per call). Example: ["PR-1", "PR-2", "10001"]

rankAfterIssuestringoptionalIssue ID or key that the moved issues should be ranked after.

rankBeforeIssuestringoptionalIssue ID or key that the moved issues should be ranked before.

rankCustomFieldIdintegeroptionalThe custom field ID of the Rank field to use for ranking, if the default rank field should not be used.

jira_board_backlog_approximate_count_get#Retrieve an approximate count of issues in the backlog of a Jira Software board, optionally filtered by a JQL query. Useful for quickly estimating backlog size without fetching full issue data.2 params▾

Retrieve an approximate count of issues in the backlog of a Jira Software board, optionally filtered by a JQL query. Useful for quickly estimating backlog size without fetching full issue data.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board that has the backlog containing the requested issues.

jqlstringoptionalFilters results using a JQL query. Do not use username or userkey as search terms; use accountId instead.

jira_board_backlog_issues_list#Returns all issues from a board's backlog, for the given board ID. Only includes issues the user has permission to view. The backlog contains incomplete issues not assigned to any future or active sprint. Issues include Agile fields such as sprint, closedSprints, flagged, and epic. Results are ordered by rank by default and can be filtered with a JQL query.7 params▾

Returns all issues from a board's backlog, for the given board ID. Only includes issues the user has permission to view. The backlog contains incomplete issues not assigned to any future or active sprint. Issues include Agile fields such as sprint, closedSprints, flagged, and epic. Results are ordered by rank by default and can be filtered with a JQL query.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board that has the backlog containing the requested issues.

expandstringoptionalThis parameter is currently not used by the Jira API but is accepted for forward compatibility.

fieldsstringoptionalComma-separated list of fields to return for each issue. By default, all navigable and Agile fields are returned.

jqlstringoptionalFilters results using a JQL query. If you define an order in your JQL query, it overrides the default rank order. Note: username and userkey cannot be used as search terms; use accountId instead.

maxResultsintegeroptionalThe maximum number of issues to return per page. Default is 50. The total number of issues returned is limited by the 'jira.search.views.default.max' property on the Jira instance; results may be truncated if this limit is exceeded.

startAtintegeroptionalThe starting index of the returned issues (zero-based). Used for pagination.

validateQuerybooleanoptionalSpecifies whether to validate the JQL query. Default is true.

jira_board_configuration_get#Retrieves the configuration of a Jira Software board by its ID. The response includes the board's filter, location, column configuration (statuses mapped to columns and min/max constraints), estimation settings (Scrum only), sub-query (Kanban only), and ranking custom field.1 param▾

Retrieves the configuration of a Jira Software board by its ID. The response includes the board's filter, location, column configuration (statuses mapped to columns and min/max constraints), estimation settings (Scrum only), sub-query (Kanban only), and ranking custom field.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board for which configuration is requested.

jira_board_create#Creates a new Jira Software board. Requires a name, a type (scrum or kanban), and a filterId for an existing filter the user has permission to view. Optionally specify a location (project or user) to control where the board is created. Note: if the user lacks the 'Create shared objects' permission and tries to create a shared board, a private board is created instead.5 params▾

Creates a new Jira Software board. Requires a name, a type (scrum or kanban), and a filterId for an existing filter the user has permission to view. Optionally specify a location (project or user) to control where the board is created. Note: if the user lacks the 'Create shared objects' permission and tries to create a shared board, a private board is created instead.

NameTypeRequiredDescription

filterIdintegerrequiredThe ID of a filter that the user has permission to view. Board sharing depends on the filter's sharing settings. If you do not order by the Rank field in the filter, you will not be able to reorder issues on the board.

namestringrequiredThe name of the board to create. Must be less than 255 characters.

typestringrequiredThe type of board to create. Valid values: scrum, kanban.

locationProjectKeyOrIdstringoptionalThe project key or ID to locate the board in. Required only when locationType is 'project'; must not be provided when locationType is 'user'.

locationTypestringoptionalThe type of container the board will be located in. Valid values: project, user. If 'project', a project must be specified via locationProjectKeyOrId. If 'user', the current user is chosen by default and locationProjectKeyOrId should not be provided.

jira_board_delete#Permanently deletes a Jira Software board by its ID. The user must be a Jira Administrator or a board administrator to remove the board. Next-gen boards cannot be deleted because next-gen software projects must have a board. This action cannot be undone.1 param▾

Permanently deletes a Jira Software board by its ID. The user must be a Jira Administrator or a board administrator to remove the board. Next-gen boards cannot be deleted because next-gen software projects must have a board. This action cannot be undone.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board to be deleted.

jira_board_epic_issues_list#Returns all issues that belong to a given epic on a board, for the given board ID and epic ID. Only includes issues the user has permission to view. Issues include Agile fields such as sprint, closedSprints, flagged, and epic. Results are ordered by rank by default and can be filtered with a JQL query.8 params▾

Returns all issues that belong to a given epic on a board, for the given board ID and epic ID. Only includes issues the user has permission to view. Issues include Agile fields such as sprint, closedSprints, flagged, and epic. Results are ordered by rank by default and can be filtered with a JQL query.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board that contains the requested issues.

epicIdintegerrequiredThe ID of the epic that contains the requested issues.

expandstringoptionalComma-separated list of parameters to expand in the response.

fieldsstringoptionalComma-separated list of fields to return for each issue. By default, all navigable and Agile fields are returned.

jqlstringoptionalFilters results using a JQL query. If you define an order in your JQL query, it overrides the default rank order.

maxResultsintegeroptionalThe maximum number of issues to return per page. Default is 50. The total number of issues returned is limited by the 'jira.search.views.default.max' property on the Jira instance; results may be truncated if this limit is exceeded.

startAtintegeroptionalThe starting index of the returned issues (zero-based). Used for pagination.

validateQuerybooleanoptionalSpecifies whether to validate the JQL query. Default is true.

jira_board_epics_list#Returns all epics from a Jira Software board, for the given board ID. Only includes epics the user has permission to view. Supports filtering by completion status and pagination.4 params▾

Returns all epics from a Jira Software board, for the given board ID. Only includes epics the user has permission to view. Supports filtering by completion status and pagination.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board that contains the requested epics.

donestringoptionalFilters results to epics that are either done or not done. Valid values: true, false.

maxResultsintegeroptionalThe maximum number of epics to return per page. Default is 50.

startAtintegeroptionalThe starting index of the returned epics (zero-based). Used for pagination.

jira_board_feature_toggle#Enable or disable an optional feature (such as sprints or estimation) on a Jira Software board. Requires board administration permissions. Returns the updated board configuration on success.3 params▾

Enable or disable an optional feature (such as sprints or estimation) on a Jira Software board. Requires board administration permissions. Returns the updated board configuration on success.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board whose feature should be toggled. Also included in the request body as required by the API.

featurestringrequiredThe name of the feature to enable or disable, e.g. 'simplifiedEpics' or 'estimation'. The exact set of feature names depends on the board type and is not enumerated by the API.

enablingbooleanoptionalWhether the feature should be enabled (true) or disabled (false). Optional; omit to leave unchanged if supported by the API.

jira_board_features_list#Get the list of features and their current status (enabled or disabled, and coming soon flags) for a Jira Software board. Use this to inspect which optional board capabilities (e.g. sprints, estimation) are currently turned on before toggling them.1 param▾

Get the list of features and their current status (enabled or disabled, and coming soon flags) for a Jira Software board. Use this to inspect which optional board capabilities (e.g. sprints, estimation) are currently turned on before toggling them.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board to retrieve features for

jira_board_get#Retrieve details of a Jira Software board by its ID, including its name, type (scrum or kanban), and project location. The board is only returned if the requesting user has permission to view it.1 param▾

Retrieve details of a Jira Software board by its ID, including its name, type (scrum or kanban), and project location. The board is only returned if the requesting user has permission to view it.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board to retrieve

jira_board_get_by_filter#Returns any boards which use the provided filter ID. This method can be executed by users without a valid Jira Software license in order to find which boards are using a particular filter. Supports pagination.3 params▾

Returns any boards which use the provided filter ID. This method can be executed by users without a valid Jira Software license in order to find which boards are using a particular filter. Supports pagination.

NameTypeRequiredDescription

filterIdintegerrequiredThe ID of the filter to look up boards for. Not supported for next-gen boards.

maxResultsintegeroptionalThe maximum number of boards to return per page. Default is 50.

startAtintegeroptionalThe starting index of the returned boards (zero-based). Used for pagination.

jira_board_issues_approximate_count_get#Retrieve an approximate count of issues on a Jira Software board, optionally filtered by a JQL query. Useful for quickly estimating board size without fetching full issue data.2 params▾

Retrieve an approximate count of issues on a Jira Software board, optionally filtered by a JQL query. Useful for quickly estimating board size without fetching full issue data.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board that contains the requested issues.

jqlstringoptionalFilters results using a JQL query. Do not use username or userkey as search terms; use accountId instead.

jira_board_issues_list#Get a paginated list of issues assigned to a Jira Software board, optionally filtered by JQL. Returns issue details for issues visible to the requesting user, with support for pagination, field selection, and expansion of additional issue data.7 params▾

Get a paginated list of issues assigned to a Jira Software board, optionally filtered by JQL. Returns issue details for issues visible to the requesting user, with support for pagination, field selection, and expansion of additional issue data.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board to retrieve issues for

expandstringoptionalComma-separated list of extra data to include in the response, e.g. 'changelog'. Optional.

fieldsstringoptionalComma-separated list of fields to return for each issue, e.g. 'summary,status,assignee'. Optional; when omitted the API returns its default field set.

jqlstringoptionalA JQL query string used to filter which issues are returned, e.g. 'status="In Progress"'. Optional; when omitted all issues on the board are considered.

maxResultsintegeroptionalThe maximum number of items to return per page. Defaults to 50.

startAtintegeroptionalThe index of the first item to return in the page of results (0-based). Defaults to 0.

validateQuerybooleanoptionalWhether to validate the JQL query. Defaults to true. When false, invalid JQL is ignored rather than causing an error.

jira_board_issues_move#Move a list of issues to a Jira Software board, optionally ranking them relative to another issue. Issues can be identified by issue key or ID. On success the response body is empty; if some issues could not be moved, a per-issue rank status is returned instead.5 params▾

Move a list of issues to a Jira Software board, optionally ranking them relative to another issue. Issues can be identified by issue key or ID. On success the response body is empty; if some issues could not be moved, a per-issue rank status is returned instead.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board to move issues to

issuesarrayrequiredA list of issue keys or IDs to move to the board, e.g. ["PR-1", "10001", "PR-3"]. Maximum of 50 issues per request.

rankAfterIssuestringoptionalThe key or ID of an issue that the moved issues should be ranked after. Optional; mutually exclusive with rankBeforeIssue.

rankBeforeIssuestringoptionalThe key or ID of an issue that the moved issues should be ranked before. Optional; mutually exclusive with rankAfterIssue.

rankCustomFieldIdintegeroptionalThe ID of the custom field used for ranking, if the default rank field should not be used. Optional.

jira_board_issues_without_epic_list#Returns all issues that do not belong to any epic on a board, for the given board ID. Only includes issues the user has permission to view. Issues include Agile fields such as sprint, closedSprints, flagged, and epic. Results are ordered by rank by default and can be filtered with a JQL query.7 params▾

Returns all issues that do not belong to any epic on a board, for the given board ID. Only includes issues the user has permission to view. Issues include Agile fields such as sprint, closedSprints, flagged, and epic. Results are ordered by rank by default and can be filtered with a JQL query.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board that contains the requested issues.

expandstringoptionalComma-separated list of parameters to expand in the response.

fieldsstringoptionalComma-separated list of fields to return for each issue. By default, all navigable and Agile fields are returned.

jqlstringoptionalFilters results using a JQL query. If you define an order in your JQL query, it overrides the default rank order. Note: username and userkey cannot be used as search terms; use accountId instead.

maxResultsintegeroptionalThe maximum number of issues to return per page. The total number of issues returned is limited by the 'jira.search.views.default.max' property on the Jira instance; results may be truncated if this limit is exceeded.

startAtintegeroptionalThe starting index of the returned issues (zero-based). Used for pagination.

validateQuerybooleanoptionalSpecifies whether to validate the JQL query. Default is true.

jira_board_projects_full_list#Get the complete, unpaginated list of projects associated with a Jira Software board. Unlike the paginated projects endpoint, this returns all projects in a single response. Only projects the requesting user has permission to view are returned.1 param▾

Get the complete, unpaginated list of projects associated with a Jira Software board. Unlike the paginated projects endpoint, this returns all projects in a single response. Only projects the requesting user has permission to view are returned.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board to retrieve all associated projects for

jira_board_projects_list#Get a paginated list of projects associated with a Jira Software board. Only projects that the board can display issues from, and that the requesting user has permission to view, are returned.3 params▾

Get a paginated list of projects associated with a Jira Software board. Only projects that the board can display issues from, and that the requesting user has permission to view, are returned.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board to retrieve associated projects for

maxResultsintegeroptionalThe maximum number of items to return per page. Defaults to 50.

startAtintegeroptionalThe index of the first item to return in the page of results (0-based). Defaults to 0.

jira_board_property_delete#Delete a property from a Jira Software board by its property key. This permanently removes the stored key-value property from the board. Returns no content on success.2 params▾

Delete a property from a Jira Software board by its property key. This permanently removes the stored key-value property from the board. Returns no content on success.

NameTypeRequiredDescription

boardIdstringrequiredThe ID of the board from which the property will be removed.

propertyKeystringrequiredThe key of the property to remove from the board.

jira_board_property_get#Get the value of a specific custom property on a Jira Software board, identified by its property key. Returns a 404 if the board does not exist, the property key is not found, or the user lacks permission to view it.2 params▾

Get the value of a specific custom property on a Jira Software board, identified by its property key. Returns a 404 if the board does not exist, the property key is not found, or the user lacks permission to view it.

NameTypeRequiredDescription

boardIdstringrequiredThe ID of the board to retrieve the property from

propertyKeystringrequiredThe key name of the property to retrieve

jira_board_property_keys_list#Get the keys of all custom properties set on a Jira Software board. Board properties are key-value stores attached to boards for storing custom data, commonly used by Connect and Forge apps.1 param▾

Get the keys of all custom properties set on a Jira Software board. Board properties are key-value stores attached to boards for storing custom data, commonly used by Connect and Forge apps.

NameTypeRequiredDescription

boardIdstringrequiredThe ID of the board to list property keys for

jira_board_property_set#Set or update a custom property on a Jira Software board. Properties can store arbitrary JSON values (up to 32768 bytes) and are commonly used by Connect and Forge apps to persist board-scoped data. The value must be a valid, non-empty JSON string.3 params▾

Set or update a custom property on a Jira Software board. Properties can store arbitrary JSON values (up to 32768 bytes) and are commonly used by Connect and Forge apps to persist board-scoped data. The value must be a valid, non-empty JSON string.

NameTypeRequiredDescription

boardIdstringrequiredThe ID of the board to set the property on

propertyKeystringrequiredThe key name for the property

valuestringrequiredThe JSON value to store for the property, provided as a JSON string, e.g. '{"status": "deployed", "env": "production"}'. Maximum length 32768 bytes.

jira_board_quickfilter_get#Retrieve a single quick filter from a Jira Software board by its ID, including its name, JQL fragment, description, and position.2 params▾

Retrieve a single quick filter from a Jira Software board by its ID, including its name, JQL fragment, description, and position.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board that contains the requested quick filter.

quickFilterIdintegerrequiredThe ID of the requested quick filter.

jira_board_quickfilters_list#Retrieve all quick filters configured on a Jira Software board. Quick filters are saved JQL fragments used to filter the board view (e.g. by issue type or assignee). Results are paginated.3 params▾

Retrieve all quick filters configured on a Jira Software board. Quick filters are saved JQL fragments used to filter the board view (e.g. by issue type or assignee). Results are paginated.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board that contains the requested quick filters.

maxResultsintegeroptionalThe maximum number of quick filters to return per page.

startAtintegeroptionalThe starting index of the returned quick filters. Base index: 0.

jira_board_reports_list#Retrieve the list of reports available for a Jira Software board, such as burndown, velocity, and sprint reports. Returns an array of report metadata objects.1 param▾

Retrieve the list of reports available for a Jira Software board, such as burndown, velocity, and sprint reports. Returns an array of report metadata objects.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board to retrieve available reports for.

jira_board_sprint_issues_list#Retrieve all issues that belong to a specific sprint on a Jira Software board. Supports JQL filtering, field selection, and pagination. Note: username/userkey cannot be used as JQL search terms; use accountId instead.8 params▾

Retrieve all issues that belong to a specific sprint on a Jira Software board. Supports JQL filtering, field selection, and pagination. Note: username/userkey cannot be used as JQL search terms; use accountId instead.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board that contains the requested issues.

sprintIdintegerrequiredThe ID of the sprint that contains the requested issues.

expandstringoptionalA comma-separated list of the parameters to expand.

fieldsstringoptionalComma-separated list of the fields to return for each issue. By default, all navigable and Agile fields are returned.

jqlstringoptionalFilters results using a JQL query. If an order is defined in the JQL query, it overrides the default order of returned issues. Do not use username or userkey as search terms; use accountId instead.

maxResultsintegeroptionalThe maximum number of issues to return per page. Note that the total returned is limited by the 'jira.search.views.default.max' Jira instance property; results will be truncated if exceeded.

startAtintegeroptionalThe starting index of the returned issues. Base index: 0.

validateQuerybooleanoptionalSpecifies whether to validate the JQL query. Default: true.

jira_board_sprints_list#Retrieve all sprints associated with a Jira Software board, ordered first by state (closed, active, future) then by position in the backlog. Supports pagination and filtering by sprint state.4 params▾

Retrieve all sprints associated with a Jira Software board, ordered first by state (closed, active, future) then by position in the backlog. Supports pagination and filtering by sprint state.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board that contains the requested sprints.

maxResultsintegeroptionalThe maximum number of sprints to return per page.

startAtintegeroptionalThe starting index of the returned sprints. Base index: 0.

statestringoptionalFilters results to sprints in the specified states. Valid values: future, active, closed. Multiple states can be combined as a comma-separated string, e.g. "active,closed".

jira_board_versions_list#Retrieve all versions associated with a Jira Software board. Supports pagination and filtering by released status.4 params▾

Retrieve all versions associated with a Jira Software board. Supports pagination and filtering by released status.

NameTypeRequiredDescription

boardIdintegerrequiredThe ID of the board that contains the requested versions.

maxResultsintegeroptionalThe maximum number of versions to return per page.

releasedstringoptionalFilters results to versions that are either released or unreleased. Valid values: "true", "false".

startAtintegeroptionalThe starting index of the returned versions. Base index: 0.

jira_boards_list#Returns all Jira Software boards that the requesting user has permission to view. Supports filtering by board type, name, project, and filter ID, plus pagination. Use this to discover board IDs before calling other board-scoped endpoints.10 params▾

Returns all Jira Software boards that the requesting user has permission to view. Supports filtering by board type, name, project, and filter ID, plus pagination. Use this to discover board IDs before calling other board-scoped endpoints.

NameTypeRequiredDescription

expandstringoptionalComma-separated list of fields to expand for each board. Valid values: admins, permissions.

filterIdintegeroptionalFilters results to boards that are relevant to the given filter ID. Not supported for next-gen boards.

includePrivatebooleanoptionalIf true, appends private boards to the end of the list. The name and type fields are excluded from private boards for security reasons.

maxResultsintegeroptionalThe maximum number of boards to return per page. Default is 50.

namestringoptionalFilters results to boards that match or partially match the specified name.

negateLocationFilteringbooleanoptionalIf true, negates the filters used for querying by location (project). Default is false.

orderBystringoptionalOrders the results by a given field. Valid values: name, -name, +name.

projectKeyOrIdstringoptionalFilters results to boards that are relevant to a project, identified by project key or ID.

startAtintegeroptionalThe starting index of the returned boards (zero-based). Used for pagination.

typestringoptionalFilters results to boards of the specified type. Valid values: scrum, kanban, simple.

jira_bulk_assignable_users_search#Find users who can be assigned issues across one or more Jira projects, optionally filtered by a query string matched against display name, email address, or account ID. Provide projectKeys (comma-separated) plus either query or accountId. Note: this operation samples users in the startAt/maxResults range and returns only those assignable to the given projects, so it may return fewer results than maxResults.5 params▾

Find users who can be assigned issues across one or more Jira projects, optionally filtered by a query string matched against display name, email address, or account ID. Provide projectKeys (comma-separated) plus either query or accountId. Note: this operation samples users in the startAt/maxResults range and returns only those assignable to the given projects, so it may return fewer results than maxResults.

NameTypeRequiredDescription

projectKeysstringrequiredComma-separated list of project keys (case sensitive) to search assignable users across.

accountIdstringoptionalExact account ID to match against. Required unless query is specified. Max length 128.

maxResultsintegeroptionalThe maximum number of items to return per page. Defaults to 50. The API samples users in this range then filters to assignable ones, so actual results may be fewer.

querystringoptionalQuery string matched against user attributes (displayName, emailAddress) by prefix, to find relevant users. Required unless accountId is specified.

startAtintegeroptionalThe index of the first item to return in a page of results (page offset). Defaults to 0.

jira_changelogs_bulk_get#Bulk fetch changelogs for multiple issues, optionally filtered by field IDs. Returns a paginated list of changelogs for the given issues sorted by changelog date and issue ID, starting from the oldest changelog and smallest issue ID. Accepts up to 1000 issue IDs/keys and up to 10 field IDs to filter by.4 params▾

Bulk fetch changelogs for multiple issues, optionally filtered by field IDs. Returns a paginated list of changelogs for the given issues sorted by changelog date and issue ID, starting from the oldest changelog and smallest issue ID. Accepts up to 1000 issue IDs/keys and up to 10 field IDs to filter by.

NameTypeRequiredDescription

issueIdsOrKeysarrayrequiredList of issue IDs and/or keys to fetch changelogs for. A maximum of 1000 issues can be specified.

fieldIdsarrayoptionalList of field IDs to filter changelogs by. A maximum of 10 field IDs can be specified.

maxResultsintegeroptionalThe maximum number of items to return per page. Maximum allowed value is 10000.

nextPageTokenstringoptionalThe cursor for pagination, returned by a previous call to this endpoint.

jira_comments_by_ids_get#Get a paginated list of Jira comments specified by a list of comment IDs. Only comments the user has permission to view are returned. Use the expand parameter to include rendered HTML bodies or comment properties.2 params▾

Get a paginated list of Jira comments specified by a list of comment IDs. Only comments the user has permission to view are returned. Use the expand parameter to include rendered HTML bodies or comment properties.

NameTypeRequiredDescription

idsarrayrequiredThe list of comment IDs to retrieve. A maximum of 1000 IDs can be specified.

expandstringoptionalComma-separated list of additional data to include. Options: renderedBody (comment body rendered in HTML), properties (comment's properties).

jira_component_create#Create a new component in a Jira project. Components are used to group and categorize issues within a project.5 params▾

Create a new component in a Jira project. Components are used to group and categorize issues within a project.

NameTypeRequiredDescription

namestringrequiredName of the component

projectstringrequiredKey of the project to add the component to

assigneeTypestringoptionalDefault assignee type: PROJECT_DEFAULT, COMPONENT_LEAD, PROJECT_LEAD, or UNASSIGNED

descriptionstringoptionalDescription of the component

leadAccountIdstringoptionalAccount ID of the component lead

jira_component_delete#Delete a Jira project component by its ID. Optionally move issues from the deleted component to another component. Requires Administer Projects permission.2 params▾

Delete a Jira project component by its ID. Optionally move issues from the deleted component to another component. Requires Administer Projects permission.

NameTypeRequiredDescription

idstringrequiredThe component ID to delete

moveIssuesTostringoptionalComponent ID to move issues to after deleting this component

jira_component_get#Retrieve details of a Jira project component by its ID, including name, description, lead, and default assignee settings.1 param▾

Retrieve details of a Jira project component by its ID, including name, description, lead, and default assignee settings.

NameTypeRequiredDescription

idstringrequiredThe component ID to retrieve

jira_component_related_issues_get#Get the count of issues assigned to a Jira component, identified by component ID. Useful for understanding how heavily a component is used before deleting or reassigning it.1 param▾

Get the count of issues assigned to a Jira component, identified by component ID. Useful for understanding how heavily a component is used before deleting or reassigning it.

NameTypeRequiredDescription

idstringrequiredThe ID of the component to get the related issue count for.

jira_component_update#Update an existing Jira project component's name, description, lead, or default assignee settings.5 params▾

Update an existing Jira project component's name, description, lead, or default assignee settings.

NameTypeRequiredDescription

idstringrequiredThe component ID to update

assigneeTypestringoptionalUpdated default assignee type: PROJECT_DEFAULT, COMPONENT_LEAD, PROJECT_LEAD, or UNASSIGNED

descriptionstringoptionalUpdated component description

leadAccountIdstringoptionalAccount ID of the new component lead

namestringoptionalUpdated component name

jira_components_search#Search for components across one or more Jira projects, including global (Compass) components when applicable. Returns a paginated list of components. Filter by project IDs/keys and/or a text query, and control ordering by name or description.5 params▾

Search for components across one or more Jira projects, including global (Compass) components when applicable. Returns a paginated list of components. Filter by project IDs/keys and/or a text query, and control ordering by name or description.

NameTypeRequiredDescription

maxResultsintegeroptionalThe maximum number of items to return per page.

orderBystringoptionalOrder the results by a field: description, -description, +description, name, -name, or +name.

projectIdsOrKeysarrayoptionalThe project IDs and/or project keys (case sensitive) to search components in. If omitted, searches across all projects the user can browse.

querystringoptionalFilter the results using a literal string. Components with a matching name or description are returned (case insensitive).

startAtintegeroptionalThe index of the first item to return in a page of results (page offset).

jira_custom_field_create#Create a new custom field in Jira. Requires a name and a field type. Optionally specify a description and a searcher key that determines how the field can be searched via JQL and basic search. Requires the Administer Jira global permission.4 params▾

Create a new custom field in Jira. Requires a name and a field type. Optionally specify a description and a searcher key that determines how the field can be searched via JQL and basic search. Requires the Administer Jira global permission.

NameTypeRequiredDescription

namestringrequiredThe name of the custom field, as displayed in Jira. This is not the unique identifier.

typestringrequiredThe type of the custom field, e.g. com.atlassian.jira.plugin.system.customfieldtypes:textfield for a single-line text field, or com.atlassian.jira.plugin.system.customfieldtypes:float for a numeric field. See Jira docs for the full built-in list.

descriptionstringoptionalThe description of the custom field, which is displayed in Jira.

searcherKeystringoptionalThe searcher that defines how the field is searched in Jira. Must be valid for the chosen field type (e.g. textfield uses textsearcher, float uses exactnumber or numberrange). If omitted, the field is not searchable.

jira_custom_field_delete#Delete a custom field, whether it is currently in the trash or not. This operation is asynchronous. Use the returned task location to check status via the Get Task tool. Requires the Administer Jira global permission.1 param▾

Delete a custom field, whether it is currently in the trash or not. This operation is asynchronous. Use the returned task location to check status via the Get Task tool. Requires the Administer Jira global permission.

NameTypeRequiredDescription

idstringrequiredThe ID of the custom field to delete, e.g. customfield_10000

jira_custom_field_restore#Restore a custom field from the trash, making it active again. Requires the Administer Jira global permission.1 param▾

Restore a custom field from the trash, making it active again. Requires the Administer Jira global permission.

NameTypeRequiredDescription

idstringrequiredThe ID of the custom field to restore, e.g. customfield_10000

jira_custom_field_trash#Move a custom field to the trash. Trashed fields can later be restored or permanently deleted. Requires the Administer Jira global permission.1 param▾

Move a custom field to the trash. Trashed fields can later be restored or permanently deleted. Requires the Administer Jira global permission.

NameTypeRequiredDescription

idstringrequiredThe ID of the custom field to move to trash, e.g. customfield_10000

jira_custom_field_update#Update the name, description, or searcher key of an existing custom field. Provide only the fields you want to change. Requires the Administer Jira global permission.4 params▾

Update the name, description, or searcher key of an existing custom field. Provide only the fields you want to change. Requires the Administer Jira global permission.

NameTypeRequiredDescription

fieldIdstringrequiredThe ID of the custom field to update, e.g. customfield_10000

descriptionstringoptionalThe new description of the custom field. Maximum length is 40000 characters.

namestringoptionalThe new name of the custom field. It doesn't have to be unique. Maximum length is 255 characters.

searcherKeystringoptionalThe searcher that defines how the field is searched in Jira. Must be a valid searcher for the field's type.

jira_dashboard_copy#Copy an existing Jira dashboard. The dashboard being copied must be owned by or shared with the current user. Any values provided (name, description, share permissions, edit permissions) replace those in the copied dashboard.6 params▾

Copy an existing Jira dashboard. The dashboard being copied must be owned by or shared with the current user. Any values provided (name, description, share permissions, edit permissions) replace those in the copied dashboard.

NameTypeRequiredDescription

idstringrequiredThe ID of the dashboard to copy

namestringrequiredName for the copied dashboard

descriptionstringoptionalDescription for the copied dashboard

editPermissionsarrayoptionalArray of edit permission objects for the copied dashboard. Each object specifies a type (user, group, project, projectRole, global, loggedin, authenticated) and the corresponding target. Example: [{"type": "loggedin"}]

extendAdminPermissionsbooleanoptionalWhether admin level permissions are used when copying. Should only be true if the user has the Administer Jira global permission.

sharePermissionsarrayoptionalArray of share permission objects for the copied dashboard. Each object specifies a type (user, group, project, projectRole, global, loggedin, authenticated) and the corresponding target. Example: [{"type": "global"}]

jira_dashboard_create#Creates a new Jira dashboard with a name, share permissions, and edit permissions. Share/edit permission entries describe who can view or edit the dashboard (e.g. globally shared, shared with a group, project, project role, or logged-in users).5 params▾

Creates a new Jira dashboard with a name, share permissions, and edit permissions. Share/edit permission entries describe who can view or edit the dashboard (e.g. globally shared, shared with a group, project, project role, or logged-in users).

NameTypeRequiredDescription

editPermissionsarrayrequiredArray of edit permission objects controlling who can edit the dashboard. Each object needs a 'type' (user, group, project, projectRole, global, loggedin) and, depending on type, a group/project/role/user reference. Example: [{"type":"loggedin"}]

namestringrequiredThe name of the dashboard.

sharePermissionsarrayrequiredArray of share permission objects controlling who can view the dashboard. Each object needs a 'type' (user, group, project, projectRole, global, loggedin) and, depending on type, a group/project/role/user reference. Example: [{"type":"global"}]

descriptionstringoptionalThe description of the dashboard.

extendAdminPermissionsbooleanoptionalWhether admin-level permissions are used when creating the dashboard. Should only be true if the user has Administer Jira global permission.

jira_dashboard_delete#Delete a Jira dashboard. The dashboard must be owned by the authenticated user.1 param▾

Delete a Jira dashboard. The dashboard must be owned by the authenticated user.

NameTypeRequiredDescription

idstringrequiredThe ID of the dashboard to delete

jira_dashboard_gadgets_get#Returns the gadgets placed on a specific dashboard. Optionally filter by a list of gadget IDs, module keys, or URIs; if none are provided, all gadgets on the dashboard are returned. Can be accessed anonymously.4 params▾

Returns the gadgets placed on a specific dashboard. Optionally filter by a list of gadget IDs, module keys, or URIs; if none are provided, all gadgets on the dashboard are returned. Can be accessed anonymously.

NameTypeRequiredDescription

dashboardIdintegerrequiredThe numeric ID of the dashboard whose gadgets should be listed.

gadgetIdstringoptionalComma-separated list of gadget IDs to filter by, e.g. 10000,10001.

moduleKeystringoptionalComma-separated list of gadget module keys to filter by.

uristringoptionalComma-separated list of gadget URIs to filter by.

jira_dashboard_gadgets_list#Returns a list of all available gadgets that can be added to any dashboard, including their module keys, titles, and thumbnail URLs.0 params▾

Returns a list of all available gadgets that can be added to any dashboard, including their module keys, titles, and thumbnail URLs.

jira_dashboard_get#Retrieve details of a Jira dashboard by its ID. The dashboard must be shared with the user or owned by them (admins are considered owners of the System dashboard).1 param▾

Retrieve details of a Jira dashboard by its ID. The dashboard must be shared with the user or owned by them (admins are considered owners of the System dashboard).

NameTypeRequiredDescription

idstringrequiredThe ID of the dashboard to retrieve

jira_dashboard_item_property_delete#Delete a property from a Jira dashboard item. Dashboard items are the gadgets that apps expose on a dashboard, and properties are custom key-value data an app has stored against a dashboard item.3 params▾

Delete a property from a Jira dashboard item. Dashboard items are the gadgets that apps expose on a dashboard, and properties are custom key-value data an app has stored against a dashboard item.

NameTypeRequiredDescription

dashboardIdstringrequiredThe ID of the dashboard that contains the item

itemIdstringrequiredThe ID of the dashboard item the property belongs to

propertyKeystringrequiredThe key of the dashboard item property to delete

jira_dashboard_item_property_get#Get the key and value of a property on a Jira dashboard item. Dashboard items are the gadgets that apps expose on a dashboard, and properties are custom key-value data an app has stored against a dashboard item.3 params▾

Get the key and value of a property on a Jira dashboard item. Dashboard items are the gadgets that apps expose on a dashboard, and properties are custom key-value data an app has stored against a dashboard item.

NameTypeRequiredDescription

dashboardIdstringrequiredThe ID of the dashboard that contains the item

itemIdstringrequiredThe ID of the dashboard item the property belongs to

propertyKeystringrequiredThe key of the dashboard item property to retrieve

jira_dashboard_item_property_keys_list#Get the keys of all properties for a dashboard item. Dashboard items are the gadgets that apps expose on a Jira dashboard, and properties let apps store custom data against a dashboard item.2 params▾

Get the keys of all properties for a dashboard item. Dashboard items are the gadgets that apps expose on a Jira dashboard, and properties let apps store custom data against a dashboard item.

NameTypeRequiredDescription

dashboardIdstringrequiredThe ID of the dashboard that contains the item

itemIdstringrequiredThe ID of the dashboard item to list property keys for

jira_dashboard_item_property_set#Set the value of a property on a Jira dashboard item. Use this to store custom data against a dashboard item (gadget). The value must be a valid JSON string; for the reserved key "config" on items without a complete module key, the value must be a JSON object whose keys and values are all strings.4 params▾

Set the value of a property on a Jira dashboard item. Use this to store custom data against a dashboard item (gadget). The value must be a valid JSON string; for the reserved key "config" on items without a complete module key, the value must be a JSON object whose keys and values are all strings.

NameTypeRequiredDescription

dashboardIdstringrequiredThe ID of the dashboard that contains the item

itemIdstringrequiredThe ID of the dashboard item to set the property on

propertyKeystringrequiredThe key of the dashboard item property to set. Maximum length 255 characters. If set to "config" for an item with a spec URI and no complete module key, the value must be an object with all string keys and values.

valuestringrequiredThe JSON value to store for the property, as a JSON string (e.g. '{"refreshInterval": 60}')

jira_dashboard_update#Update a Jira dashboard, replacing all its details (name, description, edit permissions, and share permissions) with the ones provided. The dashboard must be owned by the authenticated user.6 params▾

Update a Jira dashboard, replacing all its details (name, description, edit permissions, and share permissions) with the ones provided. The dashboard must be owned by the authenticated user.

NameTypeRequiredDescription

editPermissionsarrayrequiredArray of share permission objects controlling who can edit the dashboard. Each object needs a "type" (user, group, project, projectRole, global, loggedin, authenticated) and, depending on type, a group/project/role/user reference. Example: [{"type": "global"}]

idstringrequiredThe ID of the dashboard to update

namestringrequiredThe name of the dashboard

sharePermissionsarrayrequiredArray of share permission objects controlling who can view the dashboard. Each object needs a "type" (user, group, project, projectRole, global, loggedin, authenticated) and, depending on type, a group/project/role/user reference. Example: [{"type": "global"}]

descriptionstringoptionalThe description of the dashboard

extendAdminPermissionsbooleanoptionalWhether admin-level permissions are used for this update. Should only be true if the authenticated user has the Administer Jira global permission.

jira_dashboards_bulk_edit#Bulk edits up to 100 dashboards at once, applying a single action (changeOwner, changePermission, addPermission, or removePermission) across a list of dashboard IDs. The dashboards must be owned by the authenticated user, or the user must be an administrator. changeOwnerDetails is required for changeOwner; permissionDetails is required for the permission-related actions.5 params▾

Bulk edits up to 100 dashboards at once, applying a single action (changeOwner, changePermission, addPermission, or removePermission) across a list of dashboard IDs. The dashboards must be owned by the authenticated user, or the user must be an administrator. changeOwnerDetails is required for changeOwner; permissionDetails is required for the permission-related actions.

NameTypeRequiredDescription

actionstringrequiredThe bulk edit action to perform on the specified dashboards.

entityIdsarrayrequiredArray of numeric dashboard IDs to be edited (maximum 100).

changeOwnerDetailsobjectoptionalDetails of the new owner. Required when action is 'changeOwner'. Shape: {"accountId":"<atlassian-account-id>"}

extendAdminPermissionsbooleanoptionalWhether the action is executed with Administer Jira global permission rather than requiring dashboard ownership.

permissionDetailsobjectoptionalDetails of the permission to change, add, or remove. Required when action is changePermission, addPermission, or removePermission. Shape follows a share permission object, e.g. {"editPermissions":[{"type":"loggedin"}],"sharePermissions":[{"type":"global"}]}

jira_dashboards_list#Returns a list of dashboards owned by or shared with the authenticated user, optionally filtered to only favorite or owned dashboards. Supports pagination via startAt and maxResults. Can be accessed anonymously.3 params▾

Returns a list of dashboards owned by or shared with the authenticated user, optionally filtered to only favorite or owned dashboards. Supports pagination via startAt and maxResults. Can be accessed anonymously.

NameTypeRequiredDescription

filterstringoptionalFilter applied to the list of dashboards: 'favourite' returns dashboards the user has marked as favorite, 'my' returns dashboards owned by the user.

maxResultsintegeroptionalThe maximum number of dashboards to return per page. Default is 20.

startAtintegeroptionalThe index of the first item to return in a page of results (page offset). Default is 0.

jira_dashboards_search#Returns a paginated list of dashboards, similar to List Dashboards but with additional filtering options such as name, owner account ID, group, project, and status. When multiple filters are specified, only dashboards matching all of them are returned. Can be accessed anonymously.11 params▾

Returns a paginated list of dashboards, similar to List Dashboards but with additional filtering options such as name, owner account ID, group, project, and status. When multiple filters are specified, only dashboards matching all of them are returned. Can be accessed anonymously.

NameTypeRequiredDescription

accountIdstringoptionalUser account ID used to return dashboards matching owner.accountId. Cannot be used together with the owner parameter.

dashboardNamestringoptionalString used to perform a case-insensitive partial match against the dashboard name.

expandstringoptionalComma-separated list of additional dashboard data to include, e.g. description, owner, viewUrl, sharePermissions, editPermissions, isFavourite.

groupIdstringoptionalGroup ID used to return dashboards shared with a group matching sharePermissions.group.groupId. Cannot be used together with the groupname parameter.

groupnamestringoptionalGroup name used to return dashboards shared with a group matching sharePermissions.group.name. Deprecated in favor of groupId. Cannot be used together with groupId.

maxResultsintegeroptionalThe maximum number of dashboards to return per page. Default is 50.

orderBystringoptionalOrder the results by a field: description, favorite_count, id, is_favorite, name, or owner. Prefix with '-' or '+' to control sort direction.

ownerstringoptionalDeprecated due to privacy changes; use accountId instead. User name used to return dashboards matching owner.name. Cannot be used together with accountId.

projectIdintegeroptionalProject ID used to return dashboards shared with a project matching sharePermissions.project.id.

startAtintegeroptionalThe index of the first item to return in a page of results (page offset). Default is 0.

statusstringoptionalThe status to filter dashboards by: active, archived, or deleted. Default is active.

jira_default_priority_set#Set the default issue priority for the Jira site. Provide the ID of an existing priority to make it the default, or null to erase the default priority setting. Requires Administer Jira global permission.1 param▾

Set the default issue priority for the Jira site. Provide the ID of an existing priority to make it the default, or null to erase the default priority setting. Requires Administer Jira global permission.

NameTypeRequiredDescription

idstringrequiredThe ID of the priority to set as default. Must be an existing priority ID, or null to erase the default priority setting.

jira_default_resolution_set#Set the default issue resolution for the Jira site. Requires the Administer Jira global permission. Pass the ID of an existing resolution to make it the default, or null to erase the default resolution setting.1 param▾

Set the default issue resolution for the Jira site. Requires the Administer Jira global permission. Pass the ID of an existing resolution to make it the default, or null to erase the default resolution setting.

NameTypeRequiredDescription

idstringrequiredThe ID of the resolution to set as the default. Must be an existing resolution ID, or null to clear the default resolution setting.

jira_default_share_scope_get#Retrieve the default sharing settings applied to new filters and dashboards created by the current user (e.g. GLOBAL or AUTHENTICATED).0 params▾

Retrieve the default sharing settings applied to new filters and dashboards created by the current user (e.g. GLOBAL or AUTHENTICATED).

jira_default_share_scope_set#Set the default sharing scope for new filters and dashboards created by the authenticated user. Choose GLOBAL/AUTHENTICATED to share with all logged-in users by default, or PRIVATE to keep new filters and dashboards unshared by default.1 param▾

Set the default sharing scope for new filters and dashboards created by the authenticated user. Choose GLOBAL/AUTHENTICATED to share with all logged-in users by default, or PRIVATE to keep new filters and dashboards unshared by default.

NameTypeRequiredDescription

scopestringrequiredThe default sharing scope for new filters and dashboards. GLOBAL and AUTHENTICATED both share with all logged-in users (GLOBAL is returned as AUTHENTICATED in the API response). PRIVATE means not shared with any users by default.

jira_epic_get#Retrieve details of a Jira Software epic by its ID or key, including its name, summary, color, and done status. The epic is only returned if the requesting user has permission to view it. Does not work for epics in next-gen (team-managed) projects.1 param▾

Retrieve details of a Jira Software epic by its ID or key, including its name, summary, color, and done status. The epic is only returned if the requesting user has permission to view it. Does not work for epics in next-gen (team-managed) projects.

NameTypeRequiredDescription

epicIdOrKeystringrequiredThe ID or key of the epic to retrieve.

jira_epic_issues_list#Retrieve all issues that belong to a given Jira Software epic, including Agile fields such as sprint, closedSprints, flagged, and epic. Results are ordered by rank by default and only include issues the requesting user has permission to view. Not for use with next-gen (team-managed) projects — use JQL search with the parent clause instead.7 params▾

Retrieve all issues that belong to a given Jira Software epic, including Agile fields such as sprint, closedSprints, flagged, and epic. Results are ordered by rank by default and only include issues the requesting user has permission to view. Not for use with next-gen (team-managed) projects — use JQL search with the parent clause instead.

NameTypeRequiredDescription

epicIdOrKeystringrequiredThe ID or key of the epic whose issues should be listed.

expandstringoptionalA comma-separated list of the parameters to expand in the response.

fieldsarrayoptionalList of fields to return for each issue, as an array of field names.

jqlstringoptionalA JQL query used to further filter the issues returned for the epic.

maxResultsintegeroptionalThe maximum number of issues to return per page.

startAtintegeroptionalThe index of the first issue to return (0-based), used for pagination.

validateQuerybooleanoptionalWhether to validate the JQL query.

jira_epic_issues_move#Move a set of issues to a Jira Software epic, given the epic's ID or key. An issue can only belong to one epic at a time, so issues already assigned to a different epic will be reassigned. The requesting user needs edit permission for all issues and for the epic. At most 50 issues may be moved in a single call. Does not work for epics in next-gen (team-managed) projects. Returns no content on success.2 params▾

Move a set of issues to a Jira Software epic, given the epic's ID or key. An issue can only belong to one epic at a time, so issues already assigned to a different epic will be reassigned. The requesting user needs edit permission for all issues and for the epic. At most 50 issues may be moved in a single call. Does not work for epics in next-gen (team-managed) projects. Returns no content on success.

NameTypeRequiredDescription

epicIdOrKeystringrequiredThe ID or key of the epic that the issues should be moved into.

issuesarrayrequiredArray of issue ID or key strings to move into the epic (max 50 per call). Example: ["PR-10", "PR-11"]

jira_epic_issues_remove#Remove a set of issues from their epics. The requesting user needs edit permission for all issues being removed. At most 50 issues may be removed in a single call. Does not work for epics in next-gen (team-managed) projects — instead update the issue with { fields: { parent: {} } }. Returns no content on success.1 param▾

Remove a set of issues from their epics. The requesting user needs edit permission for all issues being removed. At most 50 issues may be removed in a single call. Does not work for epics in next-gen (team-managed) projects — instead update the issue with { fields: { parent: {} } }. Returns no content on success.

NameTypeRequiredDescription

issuesarrayrequiredArray of issue ID or key strings to remove from their current epic (max 50 per call). Example: ["PR-10", "PR-11"]

jira_epic_issues_without_epic_list#Retrieve all issues that do not belong to any epic, including Agile fields such as sprint, closedSprints, flagged, and epic. Only includes issues the requesting user has permission to view. Results are ordered by rank by default. Not for use with next-gen (team-managed) projects — use JQL search with the 'parent is empty' clause instead.6 params▾

Retrieve all issues that do not belong to any epic, including Agile fields such as sprint, closedSprints, flagged, and epic. Only includes issues the requesting user has permission to view. Results are ordered by rank by default. Not for use with next-gen (team-managed) projects — use JQL search with the 'parent is empty' clause instead.

NameTypeRequiredDescription

expandstringoptionalA comma-separated list of the parameters to expand in the response.

fieldsarrayoptionalList of fields to return for each issue, as an array of field names.

jqlstringoptionalA JQL query used to further filter the issues returned.

maxResultsintegeroptionalThe maximum number of issues to return per page.

startAtintegeroptionalThe index of the first issue to return (0-based), used for pagination.

validateQuerybooleanoptionalWhether to validate the JQL query.

jira_epic_rank#Move (rank) a Jira Software epic before or after another given epic. If rankCustomFieldId is not provided, the default rank field is used. Exactly one of Rank After Epic or Rank Before Epic should be provided. Does not work for epics in next-gen (team-managed) projects. Returns no content on success.4 params▾

Move (rank) a Jira Software epic before or after another given epic. If rankCustomFieldId is not provided, the default rank field is used. Exactly one of Rank After Epic or Rank Before Epic should be provided. Does not work for epics in next-gen (team-managed) projects. Returns no content on success.

NameTypeRequiredDescription

epicIdOrKeystringrequiredThe ID or key of the epic to rank relative to another epic.

rankAfterEpicstringoptionalThe ID or key of the epic that this epic should be ranked after.

rankBeforeEpicstringoptionalThe ID or key of the epic that this epic should be ranked before.

rankCustomFieldIdintegeroptionalThe custom field ID of the Rank field to use for ranking, if the default rank field should not be used.

jira_epic_update#Perform a partial update of a Jira Software epic. Fields not present in the request are left unchanged. Valid values for color.key are color_1 through color_9. Does not work for epics in next-gen (team-managed) projects. Returns the updated epic on success.5 params▾

Perform a partial update of a Jira Software epic. Fields not present in the request are left unchanged. Valid values for color.key are color_1 through color_9. Does not work for epics in next-gen (team-managed) projects. Returns the updated epic on success.

NameTypeRequiredDescription

epicIdOrKeystringrequiredThe ID or key of the epic to update.

colorKeystringoptionalThe color key to assign to the epic. Valid values are color_1 through color_9.

donebooleanoptionalWhether the epic should be marked as done.

namestringoptionalThe epic name (the short label shown on the epic's issues, distinct from the issue summary).

summarystringoptionalThe epic's issue summary (title).

jira_events_get#Retrieve all issue events configured in Jira. Issue events are the events that trigger notifications (e.g. Issue Created, Issue Updated, Issue Assigned). Requires the Administer Jira global permission.0 params▾

Retrieve all issue events configured in Jira. Issue events are the events that trigger notifications (e.g. Issue Created, Issue Updated, Issue Assigned). Requires the Administer Jira global permission.

jira_favourite_filters_get#Retrieve the visible favorite filters of the authenticated user. A favorite filter is visible if it is owned by the user, shared with a group the user belongs to, shared with a project the user can browse, or shared publicly. Can be called anonymously, though results will be empty without authentication.1 param▾

Retrieve the visible favorite filters of the authenticated user. A favorite filter is visible if it is owned by the user, shared with a group the user belongs to, shared with a project the user can browse, or shared publicly. Can be called anonymously, though results will be empty without authentication.

NameTypeRequiredDescription

expandstringoptionalComma-separated list of additional filter data to include in the response, such as sharedUsers (users the filter is shared with) or subscriptions.

jira_field_project_associations_get#Retrieve a paginated list of project associations for a given custom field. Each association contains the ID of a project the field is associated with. Requires the Administer Jira global permission.3 params▾

Retrieve a paginated list of project associations for a given custom field. Each association contains the ID of a project the field is associated with. Requires the Administer Jira global permission.

NameTypeRequiredDescription

fieldIdstringrequiredThe ID of the field, for example customfield_10000

maxResultsintegeroptionalThe maximum number of items to return per page.

startAtintegeroptionalThe index of the first item to return in a page of results (page offset).

jira_field_search#Search for Jira fields by name, type, or other criteria with pagination support. Returns paginated field results.5 params▾

Search for Jira fields by name, type, or other criteria with pagination support. Returns paginated field results.

NameTypeRequiredDescription

maxResultsintegeroptionalMaximum number of fields to return (default 50)

orderBystringoptionalSort by: contextsCount, lastUsed, name, screensCount, or -prefixed for descending

querystringoptionalSearch query to filter fields by name (case-insensitive)

startAtintegeroptionalIndex of the first field to return (default 0)

typestringoptionalFilter by field type: custom or system

jira_fields_list#Get all system and custom fields available in Jira. Returns field IDs, names, types, and whether they are custom or system fields. Use field IDs when referencing fields in JQL or issue creation.0 params▾

Get all system and custom fields available in Jira. Returns field IDs, names, types, and whether they are custom or system fields. Use field IDs when referencing fields in JQL or issue creation.

jira_filter_columns_get#Retrieve the columns configured for a filter. This column configuration is used when the filter's results are viewed in List View with Columns set to Filter. Can be called anonymously, though column details are only returned for filters visible to the caller.1 param▾

Retrieve the columns configured for a filter. This column configuration is used when the filter's results are viewed in List View with Columns set to Filter. Can be called anonymously, though column details are only returned for filters visible to the caller.

NameTypeRequiredDescription

idstringrequiredThe numeric ID of the filter to retrieve column configuration for.

jira_filter_columns_reset#Reset the authenticated user's column configuration for a filter back to the system default. Columns can only be reset for filters that are owned by the user, shared with a group the user belongs to, shared with a project the user can browse, or shared publicly.1 param▾

Reset the authenticated user's column configuration for a filter back to the system default. Columns can only be reset for filters that are owned by the user, shared with a group the user belongs to, shared with a project the user can browse, or shared publicly.

NameTypeRequiredDescription

idstringrequiredThe numeric ID of the filter whose column configuration should be reset to the default.

jira_filter_columns_set#Set the columns displayed for a filter's results in List View. Only navigable fields can be set as columns; use the Get Fields tool to find fields with navigable set to true. Columns can only be set for filters owned by the user, shared with a group the user belongs to, shared with a project the user can browse, or shared publicly.2 params▾

Set the columns displayed for a filter's results in List View. Only navigable fields can be set as columns; use the Get Fields tool to find fields with navigable set to true. Columns can only be set for filters owned by the user, shared with a group the user belongs to, shared with a project the user can browse, or shared publicly.

NameTypeRequiredDescription

columnsarrayrequiredOrdered list of navigable field IDs to use as the filter's columns. Example: ["summary", "status", "assignee"].

idstringrequiredThe numeric ID of the filter to set column configuration for.

jira_filter_create#Create a saved Jira filter with a JQL query. Filters can be shared, added to favorites, and used on Jira dashboards.4 params▾

Create a saved Jira filter with a JQL query. Filters can be shared, added to favorites, and used on Jira dashboards.

NameTypeRequiredDescription

namestringrequiredName of the filter (must be unique for the user)

descriptionstringoptionalDescription of what this filter shows

favouritebooleanoptionalWhether to add this filter to favorites immediately

jqlstringoptionalJQL query string for this filter

jira_filter_delete#Permanently delete a saved Jira filter. Only the filter owner or admins can delete a filter. This action cannot be undone.1 param▾

Permanently delete a saved Jira filter. Only the filter owner or admins can delete a filter. This action cannot be undone.

NameTypeRequiredDescription

idstringrequiredThe filter ID to delete

jira_filter_favourite_delete#Remove a filter from the authenticated user's favorites list. This only removes filters currently visible to the user; if a favorited public filter is later made private, it cannot be removed from favorites via this operation because it is no longer visible.2 params▾

Remove a filter from the authenticated user's favorites list. This only removes filters currently visible to the user; if a favorited public filter is later made private, it cannot be removed from favorites via this operation because it is no longer visible.

NameTypeRequiredDescription

idstringrequiredThe numeric ID of the filter to remove from favorites.

expandstringoptionalComma-separated list of additional filter data to include in the response, such as sharedUsers (users the filter is shared with) or subscriptions.

jira_filter_favourite_set#Add a filter to the authenticated user's favorites list. The user can only favorite filters that are owned by them, shared with a group they belong to, shared with a project they can browse, or shared publicly.2 params▾

Add a filter to the authenticated user's favorites list. The user can only favorite filters that are owned by them, shared with a group they belong to, shared with a project they can browse, or shared publicly.

NameTypeRequiredDescription

idstringrequiredThe numeric ID of the filter to add to favorites.

expandstringoptionalComma-separated list of additional filter data to include in the response, such as sharedUsers (users the filter is shared with) or subscriptions.

jira_filter_get#Retrieve a saved Jira filter by its ID, including the JQL query, name, owner, and share permissions.2 params▾

Retrieve a saved Jira filter by its ID, including the JQL query, name, owner, and share permissions.

NameTypeRequiredDescription

idstringrequiredThe filter ID to retrieve

expandstringoptionalAdditional data to include (e.g. sharedUsers, subscriptions)

jira_filter_owner_change#Change the owner of a saved Jira filter to a different user. The caller must either own the filter or hold the Administer Jira global permission.2 params▾

Change the owner of a saved Jira filter to a different user. The caller must either own the filter or hold the Administer Jira global permission.

NameTypeRequiredDescription

accountIdstringrequiredThe Atlassian account ID of the user who will become the new owner of the filter.

idstringrequiredThe numeric ID of the filter to change ownership of.

jira_filter_share_permissions_get#Retrieve the share permissions for a saved Jira filter. A filter can be shared with groups, projects, all logged-in users, or the public (the latter two are known as global share permissions). Can be called anonymously, though permissions are only returned for filters visible to the caller.1 param▾

Retrieve the share permissions for a saved Jira filter. A filter can be shared with groups, projects, all logged-in users, or the public (the latter two are known as global share permissions). Can be called anonymously, though permissions are only returned for filters visible to the caller.

NameTypeRequiredDescription

idstringrequiredThe numeric ID of the filter to retrieve share permissions for.

jira_filter_update#Update a saved Jira filter's name, description, or JQL query. Only the filter owner or admins can update a filter.4 params▾

Update a saved Jira filter's name, description, or JQL query. Only the filter owner or admins can update a filter.

NameTypeRequiredDescription

idstringrequiredThe filter ID to update

namestringrequiredUpdated filter name

descriptionstringoptionalUpdated description of the filter

jqlstringoptionalUpdated JQL query string

jira_filters_search#Search for saved Jira filters with pagination. Filter results by name, owner, project, or group. Returns filter details including JQL queries.6 params▾

Search for saved Jira filters with pagination. Filter results by name, owner, project, or group. Returns filter details including JQL queries.

NameTypeRequiredDescription

accountIdstringoptionalFilter by filter owner account ID

expandstringoptionalAdditional data to include (e.g. description, favourite, sharePermissions)

filterNamestringoptionalSearch by filter name (partial match, case-insensitive)

maxResultsintegeroptionalMaximum number of filters to return (default 50)

orderBystringoptionalField to order by (e.g. name, id, owner, favourite_count, is_favourite)

startAtintegeroptionalIndex of the first filter to return (default 0)

jira_gadget_add#Add a gadget to a Jira dashboard. Specify either a moduleKey or a uri to identify the gadget type (not both), along with an optional title, color, and position on the dashboard.7 params▾

Add a gadget to a Jira dashboard. Specify either a moduleKey or a uri to identify the gadget type (not both), along with an optional title, color, and position on the dashboard.

NameTypeRequiredDescription

dashboardIdintegerrequiredThe ID of the dashboard to add the gadget to

colorstringoptionalThe color of the gadget. Must be one of: blue, red, yellow, green, cyan, purple, gray, white.

ignoreUriAndModuleKeyValidationbooleanoptionalWhether to ignore validation of the module key and URI. Useful when the gadget belongs to an app that isn't installed.

moduleKeystringoptionalThe module key of the gadget type to add. Cannot be provided together with uri.

positionobjectoptionalThe position of the gadget on the dashboard, as a column/row object, e.g. {"column": 0, "row": 0}

titlestringoptionalThe title of the gadget as displayed on the dashboard.

uristringoptionalThe URI of the gadget type to add. Cannot be provided together with moduleKey.

jira_gadget_delete#Remove a gadget from a Jira dashboard. Other gadgets in the same column are moved up to fill the emptied position.2 params▾

Remove a gadget from a Jira dashboard. Other gadgets in the same column are moved up to fill the emptied position.

NameTypeRequiredDescription

dashboardIdintegerrequiredThe ID of the dashboard the gadget belongs to

gadgetIdintegerrequiredThe ID of the gadget to remove

jira_gadget_update#Change the title, position, and color of a gadget on a Jira dashboard.5 params▾

Change the title, position, and color of a gadget on a Jira dashboard.

NameTypeRequiredDescription

dashboardIdintegerrequiredThe ID of the dashboard the gadget belongs to

gadgetIdintegerrequiredThe ID of the gadget to update

colorstringoptionalThe new color of the gadget. Must be one of: blue, red, yellow, green, cyan, purple, gray, white.

positionobjectoptionalThe new position of the gadget, as a column/row object, e.g. {"column": 1, "row": 0}

titlestringoptionalThe new title of the gadget as displayed on the dashboard.

jira_group_member_add#Add a user to a Jira group. Requires Administer Jira global permission or the Site Administration role.3 params▾

Add a user to a Jira group. Requires Administer Jira global permission or the Site Administration role.

NameTypeRequiredDescription

accountIdstringrequiredAccount ID of the user to add to the group

groupIdstringoptionalThe group ID to add the user to (use instead of groupname)

groupnamestringoptionalThe group name to add the user to

jira_group_member_remove#Remove a user from a Jira group by their account ID. Requires Administer Jira global permission.3 params▾

Remove a user from a Jira group by their account ID. Requires Administer Jira global permission.

NameTypeRequiredDescription

accountIdstringrequiredAccount ID of the user to remove from the group

groupIdstringoptionalThe group ID to remove the user from (use instead of groupname)

groupnamestringoptionalThe group name to remove the user from

jira_group_members_list#Get a paginated list of users in a Jira group. Returns account IDs, display names, and email addresses of group members.5 params▾

Get a paginated list of users in a Jira group. Returns account IDs, display names, and email addresses of group members.

NameTypeRequiredDescription

groupIdstringoptionalThe group ID to list members of (use instead of groupname)

groupnamestringoptionalThe group name to list members of

includeInactiveUsersbooleanoptionalWhether to include inactive (deactivated) users in the results

maxResultsintegeroptionalMaximum number of members to return (default 50)

startAtintegeroptionalIndex of the first member to return (default 0)

jira_groups_find#Find Jira user groups by name. Returns groups whose names match the query. Useful for finding group names to use in permission schemes or visibility restrictions.4 params▾

Find Jira user groups by name. Returns groups whose names match the query. Useful for finding group names to use in permission schemes or visibility restrictions.

NameTypeRequiredDescription

accountIdstringoptionalFilter to only return groups the user with this account ID belongs to

excludeIdstringoptionalGroup IDs to exclude from results (comma-separated)

maxResultsintegeroptionalMaximum number of groups to return (default 20)

querystringoptionalSearch string to match against group names

jira_is_watching_issue_bulk_get#Returns, for the current user, the watched status of a list of Jira issues by ID. If an issue ID is invalid, its watched status is returned as false. Requires the 'Allow users to watch issues' option to be enabled and Browse Projects permission.1 param▾

Returns, for the current user, the watched status of a list of Jira issues by ID. If an issue ID is invalid, its watched status is returned as false. Requires the 'Allow users to watch issues' option to be enabled and Browse Projects permission.

NameTypeRequiredDescription

issueIdsarrayrequiredList of issue IDs to check watched status for

jira_issue_assign#Assign or unassign a Jira issue to a user. Pass an accountId to assign, or omit/null to unassign. The user must have the Assign Issues project permission.2 params▾

Assign or unassign a Jira issue to a user. Pass an accountId to assign, or omit/null to unassign. The user must have the Assign Issues project permission.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to assign (e.g. PROJ-123)

accountIdstringoptionalAccount ID of the user to assign. Leave null or omit to unassign.

jira_issue_changelog_list#Get the paginated change history for a Jira issue. Returns a list of changelog entries showing which fields changed, who changed them, and when.3 params▾

Get the paginated change history for a Jira issue. Returns a list of changelog entries showing which fields changed, who changed them, and when.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to retrieve changelog for

maxResultsintegeroptionalMaximum number of changelog entries to return (default 100)

startAtintegeroptionalIndex of the first entry to return for pagination (default 0)

jira_issue_changelogs_by_ids_get#Return changelogs for a single Jira issue, filtered to a specific list of changelog IDs. Requires Browse Projects permission for the project the issue belongs to.2 params▾

Return changelogs for a single Jira issue, filtered to a specific list of changelog IDs. Requires Browse Projects permission for the project the issue belongs to.

NameTypeRequiredDescription

changelogIdsarrayrequiredList of changelog IDs to retrieve

issueIdOrKeystringrequiredThe ID or key of the issue

jira_issue_comment_add#Add a comment to a Jira issue. The comment body is plain text and will be wrapped in ADF (Atlassian Document Format) for the v3 API. Optionally restrict visibility to a specific role or group.4 params▾

Add a comment to a Jira issue. The comment body is plain text and will be wrapped in ADF (Atlassian Document Format) for the v3 API. Optionally restrict visibility to a specific role or group.

NameTypeRequiredDescription

bodystringrequiredThe plain-text content of the comment

issueIdOrKeystringrequiredThe issue ID or key to add the comment to

visibility_typestringoptionalRestrict comment visibility by type: 'role' or 'group'

visibility_valuestringoptionalName of the role or group to restrict visibility to

jira_issue_comment_delete#Permanently delete a comment from a Jira issue. Only the comment author or users with Administer Projects permission can delete comments. This action cannot be undone.2 params▾

Permanently delete a comment from a Jira issue. Only the comment author or users with Administer Projects permission can delete comments. This action cannot be undone.

NameTypeRequiredDescription

idstringrequiredThe comment ID to delete

issueIdOrKeystringrequiredThe issue ID or key the comment belongs to

jira_issue_comment_get#Retrieve a specific comment on a Jira issue by comment ID. Returns the comment body, author, and timestamps.3 params▾

Retrieve a specific comment on a Jira issue by comment ID. Returns the comment body, author, and timestamps.

NameTypeRequiredDescription

idstringrequiredThe comment ID to retrieve

issueIdOrKeystringrequiredThe issue ID or key the comment belongs to

expandstringoptionalAdditional fields to include (e.g. renderedBody for HTML content)

jira_issue_comment_update#Update the body of an existing comment on a Jira issue. Only the comment author or users with Administer Projects permission can update comments.4 params▾

Update the body of an existing comment on a Jira issue. Only the comment author or users with Administer Projects permission can update comments.

NameTypeRequiredDescription

bodystringrequiredThe new plain-text content for the comment

idstringrequiredThe comment ID to update

issueIdOrKeystringrequiredThe issue ID or key the comment belongs to

notifyUsersbooleanoptionalWhether to send notifications to watchers (default true)

jira_issue_comments_list#Get all comments for a Jira issue with pagination support. Returns comment bodies, author details, and timestamps. Use expand=renderedBody to get HTML-rendered comment content.5 params▾

Get all comments for a Jira issue with pagination support. Returns comment bodies, author details, and timestamps. Use expand=renderedBody to get HTML-rendered comment content.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to list comments for

expandstringoptionalAdditional fields to include (e.g. renderedBody for HTML content)

maxResultsintegeroptionalMaximum number of comments to return (default 50)

orderBystringoptionalField to order by (created or -created for descending)

startAtintegeroptionalIndex of the first comment to return (default 0)

jira_issue_create#Create a new Jira issue or subtask in a specified project. Requires a project key, issue type, and summary. Supports assigning users, setting priority, labels, components, parent issue (for subtasks), and a plain-text description.10 params▾

Create a new Jira issue or subtask in a specified project. Requires a project key, issue type, and summary. Supports assigning users, setting priority, labels, components, parent issue (for subtasks), and a plain-text description.

NameTypeRequiredDescription

issue_typestringrequiredName of the issue type (e.g. Bug, Story, Task, Sub-task)

project_keystringrequiredKey of the project to create the issue in (e.g. PROJ)

summarystringrequiredShort summary or title of the issue

assignee_account_idstringoptionalAccount ID of the user to assign this issue to

componentsarrayoptionalList of component names to associate with this issue

descriptionstringoptionalPlain-text description of the issue (wrapped in ADF for v3 API)

fix_versionsarrayoptionalList of version names to set as fix versions

labelsarrayoptionalList of labels to apply to the issue

parent_keystringoptionalKey of the parent issue (required for Sub-task issue type)

priority_namestringoptionalPriority name for the issue (e.g. Highest, High, Medium, Low, Lowest)

jira_issue_create_meta_fields_get#Get a page of field metadata for a specified project and issue type, describing which fields are required, their allowed values, and schema. Use this to populate the request body for Create Issue. Requires the 'Create issues' project permission and can be accessed anonymously.4 params▾

Get a page of field metadata for a specified project and issue type, describing which fields are required, their allowed values, and schema. Use this to populate the request body for Create Issue. Requires the 'Create issues' project permission and can be accessed anonymously.

NameTypeRequiredDescription

issueTypeIdstringrequiredThe ID of the issue type to get field metadata for

projectIdOrKeystringrequiredThe ID or key of the project

maxResultsintegeroptionalMaximum number of items to return per page (up to 200)

startAtintegeroptionalIndex of the first item to return in a page of results

jira_issue_create_meta_issue_types_list#List the issue types available when creating an issue in a specified Jira project, including their metadata. Use this to populate valid issue_type values before calling Create Issue. Requires the 'Create issues' project permission and can be accessed anonymously.3 params▾

List the issue types available when creating an issue in a specified Jira project, including their metadata. Use this to populate valid issue_type values before calling Create Issue. Requires the 'Create issues' project permission and can be accessed anonymously.

NameTypeRequiredDescription

projectIdOrKeystringrequiredThe ID or key of the project to get creatable issue types for

maxResultsintegeroptionalMaximum number of items to return per page (up to 200)

startAtintegeroptionalIndex of the first item to return in a page of results

jira_issue_delete#Permanently delete a Jira issue and all its subtasks (if deleteSubtasks is true). This action cannot be undone. The user must have permission to delete the issue.2 params▾

Permanently delete a Jira issue and all its subtasks (if deleteSubtasks is true). This action cannot be undone. The user must have permission to delete the issue.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to delete (e.g. PROJ-123)

deleteSubtasksstringoptionalWhether to delete subtasks of this issue (required if the issue has subtasks)

jira_issue_edit_meta_get#Return the edit screen fields for a Jira issue that are visible to and editable by the current user. Use the result to determine which fields can be sent when editing the issue.3 params▾

Return the edit screen fields for a Jira issue that are visible to and editable by the current user. Use the result to determine which fields can be sent when editing the issue.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe ID or key of the issue

overrideEditableFlagbooleanoptionalWhether non-editable fields are returned. Requires Administer Jira global permission (default false)

overrideScreenSecuritybooleanoptionalWhether hidden fields are returned. Requires Administer Jira global permission (default false)

jira_issue_get#Retrieve details of a Jira issue by its ID or key. Returns fields, status, assignee, priority, comments summary, and other metadata. Use the fields parameter to limit the response to specific fields.5 params▾

Retrieve details of a Jira issue by its ID or key. Returns fields, status, assignee, priority, comments summary, and other metadata. Use the fields parameter to limit the response to specific fields.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID (e.g. 10001) or key (e.g. PROJ-123) to retrieve

expandstringoptionalComma-separated list of additional data to include (e.g. renderedFields,names,changelog)

fieldsstringoptionalComma-separated list of fields to return (use * for all, -field to exclude)

propertiesstringoptionalComma-separated list of issue properties to return

updateHistorybooleanoptionalWhether to update the issue's viewed history for the current user

jira_issue_limit_report_get#Get a report of all Jira issues that are breaching or approaching per-issue limits (e.g. field value size limits). Requires the 'Browse projects' permission for the projects the issues are in, or the 'Administer Jira' global permission for complete results.1 param▾

Get a report of all Jira issues that are breaching or approaching per-issue limits (e.g. field value size limits). Requires the 'Browse projects' permission for the projects the issues are in, or the 'Administer Jira' global permission for complete results.

NameTypeRequiredDescription

isReturningKeysbooleanoptionalWhether to return issue keys instead of issue IDs in the response

jira_issue_link_create#Create a link between two Jira issues with a specified link type (e.g. blocks, is blocked by, relates to, duplicates). Both issues must exist and the user needs Link Issues permission.4 params▾

Create a link between two Jira issues with a specified link type (e.g. blocks, is blocked by, relates to, duplicates). Both issues must exist and the user needs Link Issues permission.

NameTypeRequiredDescription

inward_issue_keystringrequiredKey of the inward issue (the issue on the 'is' side of the link type)

link_type_namestringrequiredName of the issue link type (e.g. 'Blocks', 'Relates', 'Duplicates', 'Cloners')

outward_issue_keystringrequiredKey of the outward issue (the issue on the 'causes' side of the link type)

commentstringoptionalOptional comment to add when creating the link

jira_issue_link_delete#Delete a specific issue link by its ID. This removes the relationship between the two linked issues. Requires Link Issues project permission.1 param▾

Delete a specific issue link by its ID. This removes the relationship between the two linked issues. Requires Link Issues project permission.

NameTypeRequiredDescription

linkIdstringrequiredThe issue link ID to delete

jira_issue_link_get#Retrieve details of a specific issue link by its ID, including the link type and both linked issues.1 param▾

Retrieve details of a specific issue link by its ID, including the link type and both linked issues.

NameTypeRequiredDescription

linkIdstringrequiredThe issue link ID to retrieve

jira_issue_link_type_create#Create a new issue link type, describing the reasons why issues can be linked together. Consists of a name plus descriptions of the inward and outward relationships. Requires Administer Jira global permission and issue linking must be enabled on the site.3 params▾

Create a new issue link type, describing the reasons why issues can be linked together. Consists of a name plus descriptions of the inward and outward relationships. Requires Administer Jira global permission and issue linking must be enabled on the site.

NameTypeRequiredDescription

inwardstringrequiredDescription of the inward link relationship

namestringrequiredThe name of the issue link type

outwardstringrequiredDescription of the outward link relationship

jira_issue_link_type_delete#Delete an issue link type from the Jira instance. Requires issue linking to be enabled on the site and Administer Jira global permission.1 param▾

Delete an issue link type from the Jira instance. Requires issue linking to be enabled on the site and Administer Jira global permission.

NameTypeRequiredDescription

issueLinkTypeIdstringrequiredThe ID of the issue link type to delete

jira_issue_link_type_get#Retrieve details of a single issue link type by its ID, including its name and the inward/outward relationship descriptions (e.g. blocks/is blocked by). Requires issue linking to be enabled on the site.1 param▾

Retrieve details of a single issue link type by its ID, including its name and the inward/outward relationship descriptions (e.g. blocks/is blocked by). Requires issue linking to be enabled on the site.

NameTypeRequiredDescription

issueLinkTypeIdstringrequiredThe ID of the issue link type to retrieve

jira_issue_link_type_update#Update the name, inward description, or outward description of an existing issue link type. Requires issue linking to be enabled on the site and Administer Jira global permission.4 params▾

Update the name, inward description, or outward description of an existing issue link type. Requires issue linking to be enabled on the site and Administer Jira global permission.

NameTypeRequiredDescription

issueLinkTypeIdstringrequiredThe ID of the issue link type to update

inwardstringoptionalThe description of the issue link type's inward link (e.g. 'is blocked by')

namestringoptionalThe name of the issue link type (e.g. 'Blocks')

outwardstringoptionalThe description of the issue link type's outward link (e.g. 'blocks')

jira_issue_link_types_list#Return a list of all issue link types configured in the Jira site. Requires issue linking to be enabled and Browse Projects permission for at least one project.0 params▾

Return a list of all issue link types configured in the Jira site. Requires issue linking to be enabled and Browse Projects permission for at least one project.

jira_issue_notify#Create an email notification for a Jira issue and add it to the mail queue. Notifications can be sent to the reporter, assignee, watchers, voters, or an explicit list of account IDs and group names, and can optionally be restricted to users with a specific permission or group.12 params▾

Create an email notification for a Jira issue and add it to the mail queue. Notifications can be sent to the reporter, assignee, watchers, voters, or an explicit list of account IDs and group names, and can optionally be restricted to users with a specific permission or group.

NameTypeRequiredDescription

issueIdOrKeystringrequiredID or key of the issue that the notification is sent for

htmlBodystringoptionalHTML body of the email notification

notify_assigneebooleanoptionalWhether to notify the issue assignee

notify_reporterbooleanoptionalWhether to notify the issue reporter

notify_votersbooleanoptionalWhether to notify all voters of the issue

notify_watchersbooleanoptionalWhether to notify all watchers of the issue

recipient_account_idsarrayoptionalList of additional Atlassian account IDs to notify

recipient_group_namesarrayoptionalList of group names to notify

restrict_group_namesarrayoptionalRestrict the notification to users who are members of these groups

restrict_permissionsarrayoptionalRestrict the notification to users who have these permission keys

subjectstringoptionalSubject of the email notification. If not specified, defaults to the issue key and summary

textBodystringoptionalPlain text body of the email notification

jira_issue_picker_suggestions_get#Get lists of Jira issues matching a query string, for use in auto-completion when a user is searching for an issue by a word or string. Returns a 'History Search' list (from the user's history of created, edited, or viewed issues) and a 'Current Search' list (from issues matching an optional JQL expression), both filtered by the query string.6 params▾

Get lists of Jira issues matching a query string, for use in auto-completion when a user is searching for an issue by a word or string. Returns a 'History Search' list (from the user's history of created, edited, or viewed issues) and a 'Current Search' list (from issues matching an optional JQL expression), both filtered by the query string.

NameTypeRequiredDescription

currentIssueKeystringoptionalThe key of an issue to exclude from search results (e.g. the issue currently being viewed)

currentJQLstringoptionalA JQL query defining the list of issues to search within. Note: username and userkey cannot be used as search terms here for privacy reasons; use accountId instead.

currentProjectIdstringoptionalThe ID of a project that suggested issues must belong to

querystringoptionalText to match against issue fields such as title, description, or comments

showSubTaskParentbooleanoptionalWhen currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query

showSubTasksbooleanoptionalWhether to include subtasks in the suggestions list

jira_issue_property_delete#Delete a custom property from a Jira issue by its property key.2 params▾

Delete a custom property from a Jira issue by its property key.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key the property belongs to

propertyKeystringrequiredThe key of the property to delete

jira_issue_property_get#Get the value of a custom property set on a Jira issue by its property key.2 params▾

Get the value of a custom property set on a Jira issue by its property key.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key the property belongs to

propertyKeystringrequiredThe key of the property to retrieve

jira_issue_property_keys_list#Get the keys of all custom properties set on a Jira issue. Issue properties are key-value stores attached to issues for storing custom data.1 param▾

Get the keys of all custom properties set on a Jira issue. Issue properties are key-value stores attached to issues for storing custom data.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to list property keys for

jira_issue_property_set#Set or update a custom property on a Jira issue. Properties can store arbitrary JSON values and are visible to apps and API consumers. The value must be a valid JSON string.3 params▾

Set or update a custom property on a Jira issue. Properties can store arbitrary JSON values and are visible to apps and API consumers. The value must be a valid JSON string.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to set the property on

propertyKeystringrequiredThe key name for the property

valuestringrequiredThe JSON value to store for the property (as a JSON string)

jira_issue_remote_link_create#Create a remote link from a Jira issue to an external resource (e.g. a GitHub PR, Confluence page, or deployment URL). If a globalId is provided and already exists, the remote link is updated instead.5 params▾

Create a remote link from a Jira issue to an external resource (e.g. a GitHub PR, Confluence page, or deployment URL). If a globalId is provided and already exists, the remote link is updated instead.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to attach the remote link to

urlstringrequiredURL of the remote resource

url_titlestringrequiredDisplay title for the remote link

globalIdstringoptionalGlobal ID that identifies the remote object. Used to deduplicate links.

relationshipstringoptionalThe relationship label describing how the remote object relates to the issue (e.g. 'fixes', 'is mentioned in')

jira_issue_remote_link_delete#Delete a remote link from a Jira issue by its link ID or by global ID. Provide either linkId (in the path) or globalId (as query param) to identify the link to delete.3 params▾

Delete a remote link from a Jira issue by its link ID or by global ID. Provide either linkId (in the path) or globalId (as query param) to identify the link to delete.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key the remote link belongs to

globalIdstringoptionalDelete all remote links matching this global ID (use instead of linkId)

linkIdstringoptionalThe remote link ID to delete

jira_issue_remote_link_get#Get a specific remote link on a Jira issue by its link ID.2 params▾

Get a specific remote link on a Jira issue by its link ID.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key the remote link belongs to

linkIdstringrequiredThe remote link ID to retrieve

jira_issue_remote_link_update#Update an existing remote link on a Jira issue by its link ID. Can change the URL, title, or relationship label.5 params▾

Update an existing remote link on a Jira issue by its link ID. Can change the URL, title, or relationship label.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key the remote link belongs to

linkIdstringrequiredThe remote link ID to update

urlstringrequiredUpdated URL of the remote resource

url_titlestringrequiredUpdated display title for the remote link

relationshipstringoptionalUpdated relationship label

jira_issue_remote_links_list#Get all remote links for a Jira issue. Remote links connect issues to external resources (e.g. GitHub PRs, Confluence pages, deployment URLs).2 params▾

Get all remote links for a Jira issue. Remote links connect issues to external resources (e.g. GitHub PRs, Confluence pages, deployment URLs).

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to list remote links for

globalIdstringoptionalFilter by global ID of the remote link

jira_issue_transition#Move a Jira issue to a new workflow status using a transition. Use the List Issue Transitions tool to get valid transition IDs. Optionally update fields or add a comment during the transition.3 params▾

Move a Jira issue to a new workflow status using a transition. Use the List Issue Transitions tool to get valid transition IDs. Optionally update fields or add a comment during the transition.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to transition (e.g. PROJ-123)

transitionIdstringrequiredThe ID of the transition to perform. Use jira_issue_transitions_list to find valid IDs.

commentstringoptionalComment to add when performing the transition

jira_issue_transitions_list#Get the available workflow transitions for a Jira issue. Returns the list of transitions the current user can perform, including transition IDs needed for the transition endpoint.3 params▾

Get the available workflow transitions for a Jira issue. Returns the list of transitions the current user can perform, including transition IDs needed for the transition endpoint.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to retrieve transitions for

expandstringoptionalAdditional data to include (e.g. transitions.fields for field metadata per transition)

transitionIdstringoptionalFilter results to only this transition ID

jira_issue_type_create#Create a new issue type in the Jira instance. Requires Administer Jira global permission. The new type will be available to all projects that use the default issue type scheme.4 params▾

Create a new issue type in the Jira instance. Requires Administer Jira global permission. The new type will be available to all projects that use the default issue type scheme.

NameTypeRequiredDescription

namestringrequiredName of the new issue type

descriptionstringoptionalDescription of the issue type

hierarchyLevelintegeroptionalHierarchy level: -1 for subtask, 0 for standard (default)

typestringoptionalType classification: subtask or standard (default)

jira_issue_type_delete#Delete a Jira issue type. If issues of this type exist, you must provide an alternative issue type ID to migrate them to. Requires Administer Jira global permission.2 params▾

Delete a Jira issue type. If issues of this type exist, you must provide an alternative issue type ID to migrate them to. Requires Administer Jira global permission.

NameTypeRequiredDescription

idstringrequiredThe issue type ID to delete

alternativeIssueTypeIdstringoptionalID of an alternative issue type to migrate existing issues to

jira_issue_type_get#Retrieve details of a specific Jira issue type by its ID, including name, description, icon URL, and hierarchy level.1 param▾

Retrieve details of a specific Jira issue type by its ID, including name, description, icon URL, and hierarchy level.

NameTypeRequiredDescription

idstringrequiredThe issue type ID to retrieve

jira_issue_type_update#Update an existing Jira issue type's name or description. Requires Administer Jira global permission.3 params▾

Update an existing Jira issue type's name or description. Requires Administer Jira global permission.

NameTypeRequiredDescription

idstringrequiredThe issue type ID to update

descriptionstringoptionalUpdated description of the issue type

namestringoptionalUpdated name for the issue type

jira_issue_types_list#Get all issue types available in the Jira instance (e.g. Bug, Story, Task, Epic, Sub-task). Returns issue type IDs, names, icons, and hierarchy levels.0 params▾

Get all issue types available in the Jira instance (e.g. Bug, Story, Task, Epic, Sub-task). Returns issue type IDs, names, icons, and hierarchy levels.

jira_issue_update#Update fields of an existing Jira issue. All fields are optional — only provided fields are changed. Supports updating summary, description, assignee, priority, labels, components, and fix versions.9 params▾

Update fields of an existing Jira issue. All fields are optional — only provided fields are changed. Supports updating summary, description, assignee, priority, labels, components, and fix versions.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to update (e.g. PROJ-123)

assignee_account_idstringoptionalAccount ID of the new assignee. Pass empty string to unassign.

componentsarrayoptionalList of component names to set on this issue (replaces existing)

descriptionstringoptionalUpdated plain-text description (wrapped in ADF for v3 API)

fix_versionsarrayoptionalList of version names to set as fix versions (replaces existing)

labelsarrayoptionalList of labels to set on the issue (replaces existing labels)

notifyUsersbooleanoptionalWhether to send notifications to watchers (default true)

priority_namestringoptionalUpdated priority name (e.g. Highest, High, Medium, Low, Lowest)

summarystringoptionalUpdated summary/title of the issue

jira_issue_vote_add#Cast a vote for a Jira issue on behalf of the authenticated user. Voting indicates the user wants this issue resolved. Only non-resolved issues can be voted on.1 param▾

Cast a vote for a Jira issue on behalf of the authenticated user. Voting indicates the user wants this issue resolved. Only non-resolved issues can be voted on.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to vote on

jira_issue_vote_delete#Remove the authenticated user's vote from a Jira issue. Only the user who cast the vote can remove it.1 param▾

Remove the authenticated user's vote from a Jira issue. Only the user who cast the vote can remove it.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to remove the vote from

jira_issue_votes_get#Get vote information for a Jira issue, including the total vote count and whether the current user has voted.1 param▾

Get vote information for a Jira issue, including the total vote count and whether the current user has voted.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to get votes for

jira_issue_watcher_add#Add a user as a watcher to a Jira issue. If no accountId is provided, the currently authenticated user is added as a watcher.2 params▾

Add a user as a watcher to a Jira issue. If no accountId is provided, the currently authenticated user is added as a watcher.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to add a watcher to

accountIdstringoptionalAccount ID of the user to add as a watcher. Omit to add the authenticated user.

jira_issue_watcher_remove#Remove a user from the watchers list of a Jira issue. Requires the accountId of the user to remove.2 params▾

Remove a user from the watchers list of a Jira issue. Requires the accountId of the user to remove.

NameTypeRequiredDescription

accountIdstringrequiredAccount ID of the user to remove from watchers

issueIdOrKeystringrequiredThe issue ID or key to remove the watcher from

jira_issue_watchers_get#Get the list of users watching a Jira issue. Returns the watcher count and user details for each watcher.1 param▾

Get the list of users watching a Jira issue. Returns the watcher count and user details for each watcher.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to get watchers for

jira_issue_worklog_add#Log time worked against a Jira issue. Specify time spent using Jira duration format (e.g. '2h 30m', '1d'). Optionally set the start time and add a comment. Requires Log Work project permission.6 params▾

Log time worked against a Jira issue. Specify time spent using Jira duration format (e.g. '2h 30m', '1d'). Optionally set the start time and add a comment. Requires Log Work project permission.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to log time against

timeSpentstringrequiredTime spent in Jira duration format (e.g. '2h 30m', '1d', '45m')

adjustEstimatestringoptionalHow to adjust the remaining estimate: 'auto', 'new', 'manual', 'leave' (default auto)

commentstringoptionalOptional comment describing the work done

newEstimatestringoptionalNew remaining estimate when adjustEstimate is 'new' or 'manual' (e.g. '2h 30m')

startedstringoptionalDate/time when work started in ISO 8601 format (e.g. 2024-01-15T08:00:00.000+0000)

jira_issue_worklog_delete#Delete a worklog entry from a Jira issue. Only the worklog author or admins can delete worklogs. Optionally adjust the remaining time estimate.4 params▾

Delete a worklog entry from a Jira issue. Only the worklog author or admins can delete worklogs. Optionally adjust the remaining time estimate.

NameTypeRequiredDescription

idstringrequiredThe worklog ID to delete

issueIdOrKeystringrequiredThe issue ID or key the worklog belongs to

adjustEstimatestringoptionalHow to adjust the remaining estimate: 'auto', 'manual', 'leave' (default auto)

increaseBystringoptionalAmount to increase the remaining estimate by (used when adjustEstimate is 'manual')

jira_issue_worklog_get#Get a specific worklog entry for a Jira issue by worklog ID. Returns time spent, author, start time, and any associated comment.2 params▾

Get a specific worklog entry for a Jira issue by worklog ID. Returns time spent, author, start time, and any associated comment.

NameTypeRequiredDescription

idstringrequiredThe worklog ID to retrieve

issueIdOrKeystringrequiredThe issue ID or key the worklog belongs to

jira_issue_worklog_update#Update an existing worklog entry on a Jira issue. Can change the time spent, start time, and comment. Only the worklog author or admins can update worklogs.7 params▾

Update an existing worklog entry on a Jira issue. Can change the time spent, start time, and comment. Only the worklog author or admins can update worklogs.

NameTypeRequiredDescription

idstringrequiredThe worklog ID to update

issueIdOrKeystringrequiredThe issue ID or key the worklog belongs to

adjustEstimatestringoptionalHow to adjust the remaining estimate: 'auto', 'new', 'manual', 'leave'

commentstringoptionalUpdated comment for the worklog

newEstimatestringoptionalNew remaining estimate when adjustEstimate is 'new' or 'manual'

startedstringoptionalUpdated start time in ISO 8601 format

timeSpentstringoptionalUpdated time spent in Jira duration format (e.g. '3h', '1d 2h')

jira_issue_worklogs_bulk_delete#Delete a list of worklogs from a Jira issue in a single request. Up to 5000 worklogs can be deleted at once; no notifications are sent for deleted worklogs. Time tracking must be enabled in Jira.4 params▾

Delete a list of worklogs from a Jira issue in a single request. Up to 5000 worklogs can be deleted at once; no notifications are sent for deleted worklogs. Time tracking must be enabled in Jira.

NameTypeRequiredDescription

idsarrayrequiredList of worklog IDs to delete

issueIdOrKeystringrequiredThe ID or key of the issue

adjustEstimatestringoptionalHow to update the issue's time estimate: 'leave' or 'auto' (default auto)

overrideEditableFlagbooleanoptionalWhether worklogs are removed even if the issue is not editable (default false)

jira_issue_worklogs_bulk_move#Move a list of worklogs from a source Jira issue to a destination issue. Up to 5000 worklogs can be moved at once. Worklogs containing attachments or restricted by project roles cannot be moved, and no notifications, webhooks, or issue history are generated for moved worklogs. Time tracking must be enabled in Jira.5 params▾

Move a list of worklogs from a source Jira issue to a destination issue. Up to 5000 worklogs can be moved at once. Worklogs containing attachments or restricted by project roles cannot be moved, and no notifications, webhooks, or issue history are generated for moved worklogs. Time tracking must be enabled in Jira.

NameTypeRequiredDescription

destination_issue_id_or_keystringrequiredThe ID or key of the destination issue the worklogs are moved to

idsarrayrequiredList of worklog IDs to move

issueIdOrKeystringrequiredThe ID or key of the source issue whose worklogs are being moved

adjustEstimatestringoptionalHow to update the issues' time estimate: 'leave' or 'auto' (default auto)

overrideEditableFlagbooleanoptionalWhether worklogs are moved even if the issues are not editable (default false)

jira_issue_worklogs_list#Get all worklogs logged against a Jira issue with pagination support. Returns time spent, author, and timestamps for each worklog entry.5 params▾

Get all worklogs logged against a Jira issue with pagination support. Returns time spent, author, and timestamps for each worklog entry.

NameTypeRequiredDescription

issueIdOrKeystringrequiredThe issue ID or key to list worklogs for

maxResultsintegeroptionalMaximum number of worklogs to return (default 5000)

startAtintegeroptionalIndex of the first worklog entry to return (default 0)

startedAfterintegeroptionalReturn worklogs started on or after this time (Unix timestamp in milliseconds)

startedBeforeintegeroptionalReturn worklogs started on or before this time (Unix timestamp in milliseconds)

jira_issues_archive#Archive up to 1000 Jira issues in a single request by issue ID or key. Returns details of the issues archived and any errors encountered. Subtasks cannot be archived directly (only through their parent), and only issues from software, service management, and business projects can be archived. Requires Jira admin or site admin permission.1 param▾

Archive up to 1000 Jira issues in a single request by issue ID or key. Returns details of the issues archived and any errors encountered. Subtasks cannot be archived directly (only through their parent), and only issues from software, service management, and business projects can be archived. Requires Jira admin or site admin permission.

NameTypeRequiredDescription

issueIdsOrKeysarrayrequiredList of issue IDs or keys to archive

jira_issues_async_archive#Archive up to 100,000 Jira issues in a single request using a JQL query. This is an asynchronous operation that returns a task URL to check progress via the Get Task tool. Subtasks cannot be archived directly (only through their parent), and only issues from software, service management, and business projects can be archived. Requires Jira admin or site admin permission.1 param▾

Archive up to 100,000 Jira issues in a single request using a JQL query. This is an asynchronous operation that returns a task URL to check progress via the Get Task tool. Subtasks cannot be archived directly (only through their parent), and only issues from software, service management, and business projects can be archived. Requires Jira admin or site admin permission.

NameTypeRequiredDescription

jqlstringrequiredJQL query identifying the issues to archive

jira_issues_bulk_create#Create up to 50 Jira issues in a single API call. Each issue in the issueUpdates array must include fields with at minimum project, summary, and issuetype. Returns created issue keys and any errors.1 param▾

Create up to 50 Jira issues in a single API call. Each issue in the issueUpdates array must include fields with at minimum project, summary, and issuetype. Returns created issue keys and any errors.

NameTypeRequiredDescription

issueUpdatesarrayrequiredArray of issue objects to create. Each must have a 'fields' object with project, summary, and issuetype.

jira_issues_bulk_fetch#Fetch details for up to 100 Jira issues in a single request, identified by ID or key. Issues are returned in ascending ID order; unmatched identifiers are reported as errors rather than causing a redirect. Use fields/expand to control response detail.5 params▾

Fetch details for up to 100 Jira issues in a single request, identified by ID or key. Issues are returned in ascending ID order; unmatched identifiers are reported as errors rather than causing a redirect. Use fields/expand to control response detail.

NameTypeRequiredDescription

issueIdsOrKeysarrayrequiredList of issue IDs or keys to fetch (up to 100, IDs and keys can be mixed)

expandarrayoptionalList of additional data to include in the response, e.g. renderedFields, names, schema, transitions, operations, editmeta, changelog, versionedRepresentations

fieldsarrayoptionalList of fields to return per issue. Use *all for all fields, *navigable for navigable fields (default), or prefix a field with - to exclude it.

fieldsByKeysbooleanoptionalWhether to reference fields by their key rather than ID

propertiesarrayoptionalList of issue property keys to include in the results (maximum 5)

jira_issues_count#Get an estimated count of Jira issues that match a JQL (Jira Query Language) expression. The JQL query must be bounded (include a search restriction such as a project or assignee filter) for performance reasons. Recent updates might not be immediately reflected in the count.1 param▾

Get an estimated count of Jira issues that match a JQL (Jira Query Language) expression. The JQL query must be bounded (include a search restriction such as a project or assignee filter) for performance reasons. Recent updates might not be immediately reflected in the count.

NameTypeRequiredDescription

jqlstringoptionalA JQL expression used to filter issues. Must be a bounded query (include a search restriction). Example: 'project = PROJ AND status = Open'. Unbounded queries like 'order by key desc' are rejected.

jira_issues_match#Check whether one or more issues would be returned by one or more JQL queries. Given a list of issue IDs and a list of JQL query strings, returns which issue IDs match each JQL query. Issues are only matched against queries the user has browse permission for.2 params▾

Check whether one or more issues would be returned by one or more JQL queries. Given a list of issue IDs and a list of JQL query strings, returns which issue IDs match each JQL query. Issues are only matched against queries the user has browse permission for.

NameTypeRequiredDescription

issueIdsarrayrequiredList of numeric issue IDs to check against the JQL queries

jqlsarrayrequiredList of JQL query strings to match issues against

jira_issues_search#Search for Jira issues using JQL (Jira Query Language). Returns a paginated list of matching issues with their fields plus a nextPageToken for fetching subsequent pages. Use fields to control what data is returned per issue.6 params▾

Search for Jira issues using JQL (Jira Query Language). Returns a paginated list of matching issues with their fields plus a nextPageToken for fetching subsequent pages. Use fields to control what data is returned per issue.

NameTypeRequiredDescription

jqlstringrequiredJQL query string to filter issues (e.g. 'project = PROJ AND status = Open')

expandstringoptionalComma-separated list of additional data to include per issue (e.g. renderedFields,changelog)

fieldsstringoptionalComma-separated list of fields to return per issue (use * for all)

maxResultsintegeroptionalMaximum number of issues to return (default 50, max 100)

nextPageTokenstringoptionalPagination cursor from a previous response's nextPageToken field. Omit to get the first page.

startAtintegeroptionalDeprecated, no-op. This endpoint does not support offset-based pagination; use nextPageToken instead. Kept only for backward compatibility with existing callers.

jira_issues_search_get#Search for Jira issues using JQL (Jira Query Language) via a GET request. Supports optional read-after-write consistency via reconcileIssues. Use this when the JQL expression is short enough to fit in a query string; for long JQL expressions use the POST-based search issues tool instead. Returns a paginated list of matching issues with a nextPageToken for subsequent pages.9 params▾

Search for Jira issues using JQL (Jira Query Language) via a GET request. Supports optional read-after-write consistency via reconcileIssues. Use this when the JQL expression is short enough to fit in a query string; for long JQL expressions use the POST-based search issues tool instead. Returns a paginated list of matching issues with a nextPageToken for subsequent pages.

NameTypeRequiredDescription

expandstringoptionalComma-separated list of additional data to include per issue (e.g. renderedFields,names,changelog)

failFastbooleanoptionalFail the request early if not all field data can be retrieved. Defaults to false.

fieldsarrayoptionalList of fields to return per issue. Accepts special values *all (all fields) or *navigable (navigable fields), individual field IDs/keys, or a field prefixed with '-' to exclude it.

fieldsByKeysbooleanoptionalReference fields by their key instead of their ID. Defaults to false.

jqlstringoptionalA JQL expression used to filter issues. Must be a bounded query for performance reasons. Example: 'project = HSP'. Omit for an unbounded query such as 'order by key desc' (discouraged for large instances).

maxResultsintegeroptionalThe maximum number of items to return per page. The API may return fewer items per page when many fields/properties are requested. Maximum of 5000 issues total.

nextPageTokenstringoptionalPagination cursor from a previous response's nextPageToken field. Omit to get the first page.

propertiesarrayoptionalList of up to 5 issue property keys to include in the results.

reconcileIssuesarrayoptionalList of issue IDs to reconcile with search results for strong read-after-write consistency. Accepts up to 50 IDs. Must be consistent across paginated requests.

jira_issues_unarchive#Unarchive up to 1000 Jira issues in a single request using issue IDs or keys. Returns details of the issues unarchived and any errors encountered. Subtasks cannot be unarchived directly, only through their parent issues. Requires Jira admin or site admin permission.1 param▾

Unarchive up to 1000 Jira issues in a single request using issue IDs or keys. Returns details of the issues unarchived and any errors encountered. Subtasks cannot be unarchived directly, only through their parent issues. Requires Jira admin or site admin permission.

NameTypeRequiredDescription

issueIdsOrKeysarrayrequiredList of issue IDs or keys to unarchive

jira_jql_autocomplete_data#Get reference data for JQL query building, including available fields and operators. Useful for building dynamic JQL query interfaces.0 params▾

Get reference data for JQL query building, including available fields and operators. Useful for building dynamic JQL query interfaces.

jira_jql_autocomplete_suggestions#Get autocomplete suggestions for a JQL field value. Provide the field name and optionally a partial value to get matching suggestions.4 params▾

Get autocomplete suggestions for a JQL field value. Provide the field name and optionally a partial value to get matching suggestions.

NameTypeRequiredDescription

fieldNamestringoptionalThe JQL field to get value suggestions for

fieldValuestringoptionalPartial field value to search for suggestions

predicateNamestringoptionalThe predicate to get suggestions for (e.g. by, before, after)

predicateValuestringoptionalPartial predicate value to search for suggestions

jira_jql_parse#Parse and validate one or more JQL queries. Returns the parsed structure of valid queries and error details for invalid ones. Useful for debugging JQL syntax before executing a search.2 params▾

Parse and validate one or more JQL queries. Returns the parsed structure of valid queries and error details for invalid ones. Useful for debugging JQL syntax before executing a search.

NameTypeRequiredDescription

queriesarrayrequiredArray of JQL query strings to parse and validate

validationstringoptionalValidation mode: strict (default), warn, or none

jira_jql_sanitize#Sanitize one or more JQL queries by converting user mentions to account IDs and fixing common formatting issues. Returns the sanitized query strings.1 param▾

Sanitize one or more JQL queries by converting user mentions to account IDs and fixing common formatting issues. Returns the sanitized query strings.

NameTypeRequiredDescription

queriesarrayrequiredArray of JQL query objects to sanitize, each with a query string

jira_labels_list#Get a paginated list of all labels used across Jira issues in the instance. Useful for discovering available labels before applying them to issues.2 params▾

Get a paginated list of all labels used across Jira issues in the instance. Useful for discovering available labels before applying them to issues.

NameTypeRequiredDescription

maxResultsintegeroptionalMaximum number of labels to return (default 1000)

startAtintegeroptionalIndex of the first label to return (default 0)

jira_locale_get#Retrieve the locale for the current user. If the user has no language preference set, or the request is anonymous, the browser-detected locale is returned, falling back to the site default locale if unsupported.0 params▾

Retrieve the locale for the current user. If the user has no language preference set, or the request is anonymous, the browser-detected locale is returned, falling back to the site default locale if unsupported.

jira_my_filters_get#Retrieve the filters owned by the authenticated user. Optionally include the user's visible favorite filters as well by setting includeFavourites to true.2 params▾

Retrieve the filters owned by the authenticated user. Optionally include the user's visible favorite filters as well by setting includeFavourites to true.

NameTypeRequiredDescription

expandstringoptionalComma-separated list of additional filter data to include in the response, such as sharedUsers (users the filter is shared with) or subscriptions.

includeFavouritesbooleanoptionalWhether to include the user's visible favorite filters in the response, in addition to owned filters.

jira_myself_get#Get details of the currently authenticated Jira user. Returns account ID, display name, email address, and avatar URLs. Useful for getting your own account ID.1 param▾

Get details of the currently authenticated Jira user. Returns account ID, display name, email address, and avatar URLs. Useful for getting your own account ID.

NameTypeRequiredDescription

expandstringoptionalAdditional data to include (e.g. groups,applicationRoles)

jira_notification_scheme_get#Retrieve details of a specific Jira notification scheme by its ID, including all configured notification events and their recipients.2 params▾

Retrieve details of a specific Jira notification scheme by its ID, including all configured notification events and their recipients.

NameTypeRequiredDescription

idstringrequiredThe notification scheme ID to retrieve

expandstringoptionalAdditional data to include (e.g. all,field,group,notificationSchemeEvents,projectRole,user)

jira_notification_schemes_list#Get all notification schemes in Jira with pagination. Notification schemes define who receives emails for issue events (created, updated, resolved, etc.).3 params▾

Get all notification schemes in Jira with pagination. Notification schemes define who receives emails for issue events (created, updated, resolved, etc.).

NameTypeRequiredDescription

expandstringoptionalAdditional data to include (e.g. all,field,group,notificationSchemeEvents,projectRole,user)

maxResultsintegeroptionalMaximum number of notification schemes to return (default 50)

startAtintegeroptionalIndex of the first scheme to return (default 0)

jira_permission_grants_list#Get all permission grants in a Jira permission scheme. Returns each grant's permission type, holder type (user, group, role, etc.), and holder details.2 params▾

Get all permission grants in a Jira permission scheme. Returns each grant's permission type, holder type (user, group, role, etc.), and holder details.

NameTypeRequiredDescription

schemeIdstringrequiredThe permission scheme ID to list grants for

expandstringoptionalAdditional data to include (e.g. all,field,group,permissions,projectRole,user)

jira_permission_scheme_get#Retrieve details of a specific Jira permission scheme by its ID, including all permission grants and who they apply to.2 params▾

Retrieve details of a specific Jira permission scheme by its ID, including all permission grants and who they apply to.

NameTypeRequiredDescription

schemeIdstringrequiredThe permission scheme ID to retrieve

expandstringoptionalAdditional data to include (e.g. all,field,group,permissions,projectRole,user)

jira_permission_schemes_list#Get all permission schemes defined in the Jira instance. Returns scheme IDs, names, and descriptions. Permission schemes define who can perform which actions on issues in a project.1 param▾

Get all permission schemes defined in the Jira instance. Returns scheme IDs, names, and descriptions. Permission schemes define who can perform which actions on issues in a project.

NameTypeRequiredDescription

expandstringoptionalAdditional data to include (e.g. all,field,group,permissions,projectRole,user)

jira_preference_delete#Delete a preference of the current user, restoring the default value of a system-defined setting. Note that jira.user.locale and jira.user.timezone are deprecated preference keys.1 param▾

Delete a preference of the current user, restoring the default value of a system-defined setting. Note that jira.user.locale and jira.user.timezone are deprecated preference keys.

NameTypeRequiredDescription

keystringrequiredThe key of the preference to delete

jira_preference_get#Retrieve the value of a preference of the current user, by preference key. Returns a plain text value. Note that jira.user.locale and jira.user.timezone are deprecated preference keys.1 param▾

Retrieve the value of a preference of the current user, by preference key. Returns a plain text value. Note that jira.user.locale and jira.user.timezone are deprecated preference keys.

NameTypeRequiredDescription

keystringrequiredThe key of the preference to retrieve

jira_preference_set#Create or update a preference for the current user by sending a plain text value (e.g. 'false'). Arbitrary preferences can hold up to 255 characters. Recognized system preference keys include user.notifications.mimetype and user.default.share.private.2 params▾

Create or update a preference for the current user by sending a plain text value (e.g. 'false'). Arbitrary preferences can hold up to 255 characters. Recognized system preference keys include user.notifications.mimetype and user.default.share.private.

NameTypeRequiredDescription

keystringrequiredThe key of the preference to set. Maximum length is 255 characters.

valuestringrequiredThe plain text value to set for the preference (up to 255 characters)

jira_priorities_list#Get all issue priority levels configured in the Jira instance (e.g. Highest, High, Medium, Low, Lowest). Returns priority names and IDs for use in issue creation and filtering.0 params▾

Get all issue priority levels configured in the Jira instance (e.g. Highest, High, Medium, Low, Lowest). Returns priority names and IDs for use in issue creation and filtering.

jira_priorities_move#Change the order of issue priorities in Jira. Provide a list of priority IDs to reorder, along with either an 'after' priority ID (to place the list immediately after that priority) or a 'position' (First or Last). Requires Administer Jira global permission.3 params▾

Change the order of issue priorities in Jira. Provide a list of priority IDs to reorder, along with either an 'after' priority ID (to place the list immediately after that priority) or a 'position' (First or Last). Requires Administer Jira global permission.

NameTypeRequiredDescription

idsarrayrequiredThe list of priority IDs to reorder. Cannot contain duplicates nor the after ID.

afterstringoptionalThe ID of the priority to move the given priorities after. Required if position isn't provided. Cannot be included in ids.

positionstringoptionalThe position to move the priorities to. Required if 'after' isn't provided. Valid values: First, Last.

jira_priorities_search#Search for Jira issue priorities with pagination. Optionally filter by a list of priority IDs, a list of project IDs, priority name, or whether only the default priority should be returned.7 params▾

Search for Jira issue priorities with pagination. Optionally filter by a list of priority IDs, a list of project IDs, priority name, or whether only the default priority should be returned.

NameTypeRequiredDescription

expandstringoptionalUse 'schemes' to return the associated priority schemes for each priority (limited to first 15 schemes per priority)

idarrayoptionalList of priority IDs to filter by. Invalid IDs are ignored.

maxResultsintegeroptionalThe maximum number of items to return per page (default 50)

onlyDefaultbooleanoptionalWhether only the default priority is returned

priorityNamestringoptionalThe name of the priority to search for

projectIdarrayoptionalList of project IDs. Only priorities available in these projects are returned. Invalid project IDs are ignored.

startAtintegeroptionalThe index of the first item to return in a page of results (page offset, default 0)

jira_priority_create#Create a new issue priority level in the Jira instance. Requires a unique name, a status color in 3-digit or 6-digit hex format, and exactly one of avatarId or iconUrl for the priority icon (Jira rejects the request if neither is provided). Optionally set a description. Requires Administer Jira global permission.5 params▾

Create a new issue priority level in the Jira instance. Requires a unique name, a status color in 3-digit or 6-digit hex format, and exactly one of avatarId or iconUrl for the priority icon (Jira rejects the request if neither is provided). Optionally set a description. Requires Administer Jira global permission.

NameTypeRequiredDescription

namestringrequiredThe name of the priority. Must be unique across the instance (max 60 characters).

statusColorstringrequiredThe status color of the priority in 3-digit or 6-digit hexadecimal format

avatarIdintegeroptionalThe ID of an existing avatar to use as the icon for this priority. Provide this or iconUrl (one of the two is required by Jira).

descriptionstringoptionalA description of the priority (up to 255 characters)

iconUrlstringoptionalURL of an icon to use for this priority. Provide this or avatarId (one of the two is required by Jira).

jira_priority_delete#Delete a Jira issue priority by ID. This operation is asynchronous - follow the location header in the response to track task status. Requires Administer Jira global permission.1 param▾

Delete a Jira issue priority by ID. This operation is asynchronous - follow the location header in the response to track task status. Requires Administer Jira global permission.

NameTypeRequiredDescription

idstringrequiredThe ID of the issue priority to delete

jira_priority_get#Retrieve details of a specific Jira priority level by its ID, including name, description, icon URL, and status color.1 param▾

Retrieve details of a specific Jira priority level by its ID, including name, description, icon URL, and status color.

NameTypeRequiredDescription

idstringrequiredThe priority ID to retrieve

jira_priority_update#Update an existing Jira issue priority. At least one request body parameter must be provided. Note: iconUrl was deprecated in favor of avatarId - both cannot be set at the same time. Requires Administer Jira global permission.6 params▾

Update an existing Jira issue priority. At least one request body parameter must be provided. Note: iconUrl was deprecated in favor of avatarId - both cannot be set at the same time. Requires Administer Jira global permission.

NameTypeRequiredDescription

idstringrequiredThe ID of the issue priority to update

avatarIdintegeroptionalThe ID for the avatar to use for the priority. Nullable. Both iconUrl and avatarId cannot be defined together.

descriptionstringoptionalThe description of the priority. Maximum length 255 characters. Nullable.

iconUrlstringoptionalThe URL of a built-in icon for the priority. Deprecated in favor of avatarId. Both iconUrl and avatarId cannot be defined together. Nullable.

namestringoptionalThe name of the priority. Must be unique. Maximum length 60 characters. Nullable.

statusColorstringoptionalThe status color of the priority in 3-digit or 6-digit hexadecimal format. Nullable.

jira_project_archive#Archive a Jira project by ID or key. An archived project cannot be deleted directly; it must first be restored, then deleted. To restore a project, use the Jira UI. Requires Administer Jira global permission.1 param▾

Archive a Jira project by ID or key. An archived project cannot be deleted directly; it must first be restored, then deleted. To restore a project, use the Jira UI. Requires Administer Jira global permission.

NameTypeRequiredDescription

projectIdOrKeystringrequiredThe project ID or project key (case sensitive) to archive

jira_project_categories_list#Returns all project categories defined in the Jira instance. Project categories are used to group related projects together for organizational purposes.0 params▾

Returns all project categories defined in the Jira instance. Project categories are used to group related projects together for organizational purposes.

jira_project_category_create#Create a new project category in Jira. Project categories group related projects together. Requires Administer Jira global permission.2 params▾

Create a new project category in Jira. Project categories group related projects together. Requires Administer Jira global permission.

NameTypeRequiredDescription

namestringrequiredName of the project category. Must be unique (case-insensitive) across the Jira instance.

descriptionstringoptionalDescription of the project category

jira_project_category_delete#Delete a project category in Jira. This is a permanent operation and cannot be undone. Requires Administer Jira global permission.1 param▾

Delete a project category in Jira. This is a permanent operation and cannot be undone. Requires Administer Jira global permission.

NameTypeRequiredDescription

idstringrequiredThe numeric ID of the project category to delete

jira_project_category_get#Retrieve a single Jira project category by its numeric ID, including its name and description.1 param▾

Retrieve a single Jira project category by its numeric ID, including its name and description.

NameTypeRequiredDescription

idstringrequiredThe numeric ID of the project category to retrieve

jira_project_category_update#Update the name and/or description of an existing Jira project category. Requires Administer Jira global permission.3 params▾

Update the name and/or description of an existing Jira project category. Requires Administer Jira global permission.

NameTypeRequiredDescription

idstringrequiredThe numeric ID of the project category to update

descriptionstringoptionalUpdated description of the project category

namestringoptionalUpdated name of the project category. Must be unique (case-insensitive) across the Jira instance.

jira_project_components_all_list#Return all components in a Jira project as a single, non-paginated list. If the project uses Compass components, this returns a paginated list of Compass components linked to issues in the project instead. Can be accessed anonymously. Requires Browse Projects permission.2 params▾

Return all components in a Jira project as a single, non-paginated list. If the project uses Compass components, this returns a paginated list of Compass components linked to issues in the project instead. Can be accessed anonymously. Requires Browse Projects permission.

NameTypeRequiredDescription

projectIdOrKeystringrequiredThe project ID or project key (case sensitive) to list components for

componentSourcestringoptionalThe source of the components to return. Can be 'jira' (default), 'compass', or 'auto'. When 'auto' is specified, connected Compass components are returned if the project is opted into Compass; otherwise Jira components are returned.

jira_project_components_list#Get a paginated list of components for a Jira project. Components are sub-sections that group issues within a project.5 params▾

Get a paginated list of components for a Jira project. Components are sub-sections that group issues within a project.

NameTypeRequiredDescription

projectIdOrKeystringrequiredThe project ID or key to list components for

maxResultsintegeroptionalMaximum number of components to return

orderBystringoptionalField to order results by (e.g. name, +name, -name)

querystringoptionalFilter components by name (case-insensitive partial match)

startAtintegeroptionalIndex of the first component to return (default 0)

jira_project_create#Create a new Jira project. Requires a unique project key, project type key, and project template key. The authenticated user becomes the project lead by default.7 params▾

Create a new Jira project. Requires a unique project key, project type key, and project template key. The authenticated user becomes the project lead by default.

NameTypeRequiredDescription

keystringrequiredUnique project key (2-10 uppercase letters, e.g. PROJ)

leadAccountIdstringrequiredAccount ID of the project lead

namestringrequiredFull display name of the project

projectTemplateKeystringrequiredTemplate key to use for the project (e.g. com.pyxis.greenhopper.jira:gh-scrum-template)

projectTypeKeystringrequiredType of project: software, business, or service_desk

assigneeTypestringoptionalDefault assignee type: PROJECT_LEAD or UNASSIGNED

descriptionstringoptionalProject description

jira_project_delete#Delete a Jira project and all its issues. This is a permanent, irreversible operation. Requires Administer Jira global permission.2 params▾

Delete a Jira project and all its issues. This is a permanent, irreversible operation. Requires Administer Jira global permission.

NameTypeRequiredDescription

projectIdOrKeystringrequiredThe project ID or key to delete

enableUndobooleanoptionalWhether to place the project in a recycle bin instead of permanently deleting

jira_project_delete_async#Delete a Jira project asynchronously. This operation is transactional (if part of the delete fails, the project is not deleted) and asynchronous - follow the location link in the response to track the task status via the Get Task tool. Requires Administer Jira global permission.1 param▾

Delete a Jira project asynchronously. This operation is transactional (if part of the delete fails, the project is not deleted) and asynchronous - follow the location link in the response to track the task status via the Get Task tool. Requires Administer Jira global permission.

NameTypeRequiredDescription

projectIdOrKeystringrequiredThe project ID or project key (case sensitive) to delete asynchronously

jira_project_fields_list#Returns a paginated list of fields available for the requested projects and work types (issue types). Only fields available for the specified combination of projects and work types are returned. Optionally filter to specific field IDs.5 params▾

Returns a paginated list of fields available for the requested projects and work types (issue types). Only fields available for the specified combination of projects and work types are returned. Optionally filter to specific field IDs.

NameTypeRequiredDescription

projectIdstringrequiredComma-separated list of project IDs to return fields for

workTypeIdstringrequiredComma-separated list of work type (issue type) IDs to return fields for

fieldIdstringoptionalComma-separated list of field IDs to return. If not provided, all available fields are returned.

maxResultsintegeroptionalThe maximum number of items to return per page (1-100)

startAtintegeroptionalThe index of the first item to return in a page of results (page offset)

jira_project_get#Retrieve details of a Jira project by its ID or key, including name, type, lead, category, and metadata.2 params▾

Retrieve details of a Jira project by its ID or key, including name, type, lead, category, and metadata.

NameTypeRequiredDescription

projectIdOrKeystringrequiredThe project ID or key to retrieve (e.g. PROJ or 10001)

expandstringoptionalAdditional information to include (e.g. description,lead,issueTypes,url,projectKeys,permissions,insight)

jira_project_hierarchy_get#Get the issue type hierarchy for a next-gen (team-managed) Jira project. The hierarchy consists of an optional Epic level (level 1), one or more standard issue types such as Story, Task, or Bug at level 0, and an optional Subtask level (level -1) used to break level-0 issues into components.1 param▾

Get the issue type hierarchy for a next-gen (team-managed) Jira project. The hierarchy consists of an optional Epic level (level 1), one or more standard issue types such as Story, Task, or Bug at level 0, and an optional Subtask level (level -1) used to break level-0 issues into components.

NameTypeRequiredDescription

projectIdstringrequiredThe numeric ID of the project to fetch the issue type hierarchy for

jira_project_notification_scheme_get#Get the notification scheme associated with a Jira project. Returns the scheme's ID, name, and (optionally, via expand) the configured notification events and recipients. Requires Administer Jira or Administer Projects permission.2 params▾

Get the notification scheme associated with a Jira project. Returns the scheme's ID, name, and (optionally, via expand) the configured notification events and recipients. Requires Administer Jira or Administer Projects permission.

NameTypeRequiredDescription

projectKeyOrIdstringrequiredThe project ID or project key (case sensitive) to fetch the notification scheme for

expandstringoptionalComma-separated list of additional data to include. Options: 'all' (everything), 'field' (custom fields assigned to receive an event), 'group', 'notificationSchemeEvents', 'projectRole', 'user'.

jira_project_restore#Restore a Jira project that has been archived or placed in the recycle bin. Requires Administer Jira global permission for company-managed projects, or Administer Jira global permission / Administer Projects project permission for team-managed projects.1 param▾

Restore a Jira project that has been archived or placed in the recycle bin. Requires Administer Jira global permission for company-managed projects, or Administer Jira global permission / Administer Projects project permission for team-managed projects.

NameTypeRequiredDescription

projectIdOrKeystringrequiredThe project ID or project key (case sensitive) to restore

jira_project_role_get#Get details of a project role for a specific Jira project, including the list of members (users and groups) in the role.2 params▾

Get details of a project role for a specific Jira project, including the list of members (users and groups) in the role.

NameTypeRequiredDescription

idstringrequiredThe role ID to retrieve (numeric)

projectIdOrKeystringrequiredThe project ID or key to get the role for

jira_project_roles_list#Get all project roles defined for a specific Jira project, with URLs to get member details for each role.1 param▾

Get all project roles defined for a specific Jira project, with URLs to get member details for each role.

NameTypeRequiredDescription

projectIdOrKeystringrequiredThe project ID or key to list roles for

jira_project_statuses_list#Get all valid issue statuses for a Jira project, grouped by issue type. Returns statuses with their names, IDs, and category colors.1 param▾

Get all valid issue statuses for a Jira project, grouped by issue type. Returns statuses with their names, IDs, and category colors.

NameTypeRequiredDescription

projectIdOrKeystringrequiredThe project ID or key to get statuses for

jira_project_types_list#Get all project types available in Jira (e.g. software, business, service_desk). Returns type keys, formatted names, and descriptions.0 params▾

Get all project types available in Jira (e.g. software, business, service_desk). Returns type keys, formatted names, and descriptions.

jira_project_update#Update an existing Jira project's name, description, lead, or category. Only fields provided are updated. Requires Administer Projects permission.6 params▾

Update an existing Jira project's name, description, lead, or category. Only fields provided are updated. Requires Administer Projects permission.

NameTypeRequiredDescription

projectIdOrKeystringrequiredThe project ID or key to update

assigneeTypestringoptionalDefault assignee type: PROJECT_LEAD or UNASSIGNED

descriptionstringoptionalUpdated project description

leadAccountIdstringoptionalAccount ID of the new project lead

namestringoptionalUpdated project name

urlstringoptionalA link to information about this project

jira_project_versions_get#Returns all versions in a Jira project as a single, non-paginated list. Use this when you need every version at once; for large projects consider the paginated project versions list instead.2 params▾

Returns all versions in a Jira project as a single, non-paginated list. Use this when you need every version at once; for large projects consider the paginated project versions list instead.

NameTypeRequiredDescription

projectIdOrKeystringrequiredThe project ID or project key (case sensitive) to fetch versions for

expandstringoptionalComma-separated list of additional data to include in the response. Accepts 'operations', which returns actions that can be performed on the version.

jira_project_versions_list#Get a paginated list of versions for a Jira project. Versions are used to track releases and fix versions on issues.7 params▾

Get a paginated list of versions for a Jira project. Versions are used to track releases and fix versions on issues.

NameTypeRequiredDescription

projectIdOrKeystringrequiredThe project ID or key to list versions for

expandstringoptionalAdditional data to include (e.g. operations, issuesstatus, remotelinks, approvers)

maxResultsintegeroptionalMaximum number of versions to return

orderBystringoptionalField to order by (e.g. description, name, releaseDate, sequence, startDate)

querystringoptionalFilter versions by name (case-insensitive partial match)

startAtintegeroptionalIndex of the first version to return (default 0)

statusstringoptionalFilter by release status: released, unreleased, or archived

jira_projects_list#List all Jira projects visible to the authenticated user with support for filtering and pagination. Projects are returned only where the user has Browse Projects or Administer Projects permission.12 params▾

List all Jira projects visible to the authenticated user with support for filtering and pagination. Projects are returned only where the user has Browse Projects or Administer Projects permission.

NameTypeRequiredDescription

actionstringoptionalFilter results by the action the user can perform on the project

categoryIdintegeroptionalFilter projects by category ID

expandstringoptionalAdditional information to include in the response (comma-separated)

idstringoptionalList of project IDs to filter by (comma-separated)

keysstringoptionalList of project keys to filter by (comma-separated)

maxResultsintegeroptionalMaximum number of projects to return per page (default 50)

orderBystringoptionalField to order results by (e.g., name, key, category)

propertiesstringoptionalProject properties to return (comma-separated)

querystringoptionalText query to search for in project name and key

startAtintegeroptionalStarting index for pagination (default 0)

statusstringoptionalFilter projects by status (comma-separated: live, archived, deleted)

typeKeystringoptionalFilter projects by project type key

jira_recent_projects_list#Retrieve a list of up to 20 Jira projects recently viewed by the authenticated user that are still visible to them. Can be accessed anonymously. Only projects where the user has Browse Projects, Administer Projects, or Administer Jira permission are returned.2 params▾

Retrieve a list of up to 20 Jira projects recently viewed by the authenticated user that are still visible to them. Can be accessed anonymously. Only projects where the user has Browse Projects, Administer Projects, or Administer Jira permission are returned.

NameTypeRequiredDescription

expandstringoptionalComma-separated list of additional information to include in the response. Options: description, projectKeys, lead, issueTypes, url, insight

propertiesarrayoptionalList of project properties to return for each project (experimental). Invalid property names are ignored.

jira_related_work_delete#Delete a related work item from a Jira project version. Requires Resolve Issues and Edit Issues permissions for the project that contains the version.2 params▾

Delete a related work item from a Jira project version. Requires Resolve Issues and Edit Issues permissions for the project that contains the version.

NameTypeRequiredDescription

relatedWorkIdstringrequiredThe ID of the related work item to delete

versionIdstringrequiredThe ID of the version that the related work belongs to

jira_related_work_update#Update a related work item associated with a Jira project version. Only generic link related works can be updated via this API; native release note related works and archived version related works cannot be edited.5 params▾

Update a related work item associated with a Jira project version. Only generic link related works can be updated via this API; native release note related works and archived version related works cannot be edited.

NameTypeRequiredDescription

categorystringrequiredThe category of the related work (e.g. Design, Documentation)

idstringrequiredThe ID of the version whose related work should be updated. Pass the related work's own ID inside the request via relatedWorkId.

relatedWorkIdstringoptionalThe ID of the related work item to update. Cannot be set for the native release note related work item.

titlestringoptionalThe title of the related work

urlstringoptionalThe URL of the related work. Required unless this is the native release note related work item.

jira_resolution_create#Create a new issue resolution in Jira (e.g. Fixed, Won't Fix, Duplicate). Requires Administer Jira global permission.2 params▾

Create a new issue resolution in Jira (e.g. Fixed, Won't Fix, Duplicate). Requires Administer Jira global permission.

NameTypeRequiredDescription

namestringrequiredName of the resolution. Must be unique (case-insensitive), up to 60 characters.

descriptionstringoptionalDescription of the resolution, up to 255 characters

jira_resolution_delete#Delete a Jira issue resolution by ID. Requires a replacement resolution ID to reassign issues currently using the deleted resolution. This operation is asynchronous; follow the returned location link to track task status. Requires the Administer Jira global permission.2 params▾

Delete a Jira issue resolution by ID. Requires a replacement resolution ID to reassign issues currently using the deleted resolution. This operation is asynchronous; follow the returned location link to track task status. Requires the Administer Jira global permission.

NameTypeRequiredDescription

idstringrequiredThe ID of the issue resolution to delete.

replaceWithstringrequiredThe ID of the issue resolution that will replace the deleted resolution on any issues currently using it.

jira_resolution_get#Retrieve a single Jira issue resolution value by its ID. Returns the resolution's ID, name, and description.1 param▾

Retrieve a single Jira issue resolution value by its ID. Returns the resolution's ID, name, and description.

NameTypeRequiredDescription

idstringrequiredThe ID of the issue resolution value to retrieve.

jira_resolution_update#Update the name and/or description of an existing Jira issue resolution. Requires the Administer Jira global permission.3 params▾

Update the name and/or description of an existing Jira issue resolution. Requires the Administer Jira global permission.

NameTypeRequiredDescription

idstringrequiredThe ID of the issue resolution to update.

namestringrequiredThe new name of the resolution. Must be unique across all resolutions. Maximum length 60 characters.

descriptionstringoptionalThe new description of the resolution. Maximum length 255 characters.

jira_resolutions_move#Change the display order of Jira issue resolutions. Provide the list of resolution IDs to reorder, plus either an 'after' resolution ID (move the list after this ID) or a 'position' (First or Last). Requires the Administer Jira global permission.3 params▾

Change the display order of Jira issue resolutions. Provide the list of resolution IDs to reorder, plus either an 'after' resolution ID (move the list after this ID) or a 'position' (First or Last). Requires the Administer Jira global permission.

NameTypeRequiredDescription

idsarrayrequiredList of resolution IDs to reorder. Cannot contain duplicates or the ID given in 'after'.

afterstringoptionalThe ID of the resolution that the reordered list should be placed after. Required if 'position' is not provided.

positionstringoptionalThe position to move the resolutions to. Valid values: First, Last. Required if 'after' is not provided.

jira_resolutions_search#Search for Jira issue resolutions with pagination. Optionally filter by a list of resolution IDs or restrict results to only the default resolution (company-managed projects only).4 params▾

Search for Jira issue resolutions with pagination. Optionally filter by a list of resolution IDs or restrict results to only the default resolution (company-managed projects only).

NameTypeRequiredDescription

idarrayoptionalList of resolution IDs to filter results by.

maxResultsintegeroptionalThe maximum number of items to return per page.

onlyDefaultbooleanoptionalWhen true, return only the default resolution. If IDs are also provided and none of them is the default, an empty page is returned. Defaults to false.

startAtintegeroptionalThe index of the first item to return in a page of results (page offset).

jira_role_create#Create a new project role in the Jira instance. The role will be available to all projects. Requires Administer Jira global permission.2 params▾

Create a new project role in the Jira instance. The role will be available to all projects. Requires Administer Jira global permission.

NameTypeRequiredDescription

namestringrequiredName of the new project role

descriptionstringoptionalDescription of the role's purpose

jira_role_delete#Delete a global project role from the Jira instance. Optionally swap the role's usage in projects with another role. Requires Administer Jira global permission.2 params▾

Delete a global project role from the Jira instance. Optionally swap the role's usage in projects with another role. Requires Administer Jira global permission.

NameTypeRequiredDescription

idstringrequiredThe role ID to delete

swapstringoptionalRole ID to use as a replacement wherever this role is used

jira_role_get#Retrieve details of a global Jira project role by its ID, including name, description, and scope.1 param▾

Retrieve details of a global Jira project role by its ID, including name, description, and scope.

NameTypeRequiredDescription

idstringrequiredThe role ID to retrieve

jira_roles_list#Get all project roles defined in the Jira instance (global role list, not project-specific). Returns role IDs, names, and descriptions.0 params▾

Get all project roles defined in the Jira instance (global role list, not project-specific). Returns role IDs, names, and descriptions.

jira_share_permission_add#Add a share permission to a Jira filter, allowing it to be shared with a user, group, project, project role, or globally. Adding a global share permission overwrites all existing share permissions for the filter. Requires the 'Share dashboards and filters' global permission and filter ownership.8 params▾

Add a share permission to a Jira filter, allowing it to be shared with a user, group, project, project role, or globally. Adding a global share permission overwrites all existing share permissions for the filter. Requires the 'Share dashboards and filters' global permission and filter ownership.

NameTypeRequiredDescription

idstringrequiredThe ID of the filter to add the share permission to

typestringrequiredThe type of share permission: user, group, project, projectRole, global, or authenticated

accountIdstringoptionalThe user account ID to share the filter with (required when type is 'user')

groupIdstringoptionalThe ID of the group to share the filter with. Cannot be provided with groupname.

groupnamestringoptionalThe name of the group to share the filter with (required when type is 'group' and groupId not provided)

projectIdstringoptionalThe ID of the project to share the filter with (required when type is 'project' or 'projectRole')

projectRoleIdstringoptionalThe ID of the project role to share the filter with (required when type is 'projectRole', along with projectId)

rightsintegeroptionalThe rights for the share permission

jira_share_permission_delete#Delete a share permission from a Jira filter. Requires permission to access Jira and filter ownership.2 params▾

Delete a share permission from a Jira filter. Requires permission to access Jira and filter ownership.

NameTypeRequiredDescription

idstringrequiredThe ID of the filter that owns the share permission

permissionIdstringrequiredThe ID of the share permission to delete

jira_share_permission_get#Retrieve a share permission for a Jira filter. A filter can be shared with groups, projects, all logged-in users, or the public. This operation can be accessed anonymously, but a share permission is only returned for filters the user owns, filters shared with a group the user belongs to, or filters shared with a private project the user can browse.2 params▾

Retrieve a share permission for a Jira filter. A filter can be shared with groups, projects, all logged-in users, or the public. This operation can be accessed anonymously, but a share permission is only returned for filters the user owns, filters shared with a group the user belongs to, or filters shared with a private project the user can browse.

NameTypeRequiredDescription

idstringrequiredThe ID of the filter that owns the share permission

permissionIdstringrequiredThe ID of the share permission to retrieve

jira_sprint_create#Create a future sprint on a Jira Software board. Sprint name and origin board ID are required; start date, end date, and goal are optional. The sprint name is trimmed. Note that when starting sprints from the UI, the endDate set through this call is ignored and instead the last sprint's duration is used to fill the form.5 params▾

Create a future sprint on a Jira Software board. Sprint name and origin board ID are required; start date, end date, and goal are optional. The sprint name is trimmed. Note that when starting sprints from the UI, the endDate set through this call is ignored and instead the last sprint's duration is used to fill the form.

NameTypeRequiredDescription

namestringrequiredName of the sprint

originBoardIdintegerrequiredThe ID of the board that the sprint is created on

endDatestringoptionalEnd date of the sprint

goalstringoptionalGoal of the sprint

startDatestringoptionalStart date of the sprint

jira_sprint_delete#Delete a sprint. Once a sprint is deleted, all open issues in the sprint will be moved to the backlog.1 param▾

Delete a sprint. Once a sprint is deleted, all open issues in the sprint will be moved to the backlog.

NameTypeRequiredDescription

sprintIdintegerrequiredThe ID of the sprint to delete

jira_sprint_get#Return the sprint for a given sprint ID. The sprint will only be returned if the user can view the board that the sprint was created on, or view at least one of the issues in the sprint.1 param▾

Return the sprint for a given sprint ID. The sprint will only be returned if the user can view the board that the sprint was created on, or view at least one of the issues in the sprint.

NameTypeRequiredDescription

sprintIdintegerrequiredThe ID of the requested sprint

jira_sprint_issues_list#Return all issues in a sprint, for a given sprint ID. This only includes issues that the user has permission to view. By default, the returned issues are ordered by rank. Note: this operation is deprecated by Atlassian in favor of the Jira Cloud platform search APIs, but remains available.7 params▾

Return all issues in a sprint, for a given sprint ID. This only includes issues that the user has permission to view. By default, the returned issues are ordered by rank. Note: this operation is deprecated by Atlassian in favor of the Jira Cloud platform search APIs, but remains available.

NameTypeRequiredDescription

sprintIdintegerrequiredThe ID of the sprint that contains the requested issues

expandstringoptionalA comma-separated list of the parameters to expand

fieldsstringoptionalThe list of fields to return for each issue. By default, all navigable and Agile fields are returned.

jqlstringoptionalFilters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.

maxResultsintegeroptionalThe maximum number of issues to return per page. The total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance.

startAtintegeroptionalThe starting index of the returned issues. Base index: 0.

validateQuerybooleanoptionalSpecifies whether to validate the JQL query or not. Default: true.

jira_sprint_issues_move#Move issues to a sprint, for a given sprint ID. Issues can only be moved to open or active sprints. The maximum number of issues that can be moved in one operation is 50.5 params▾

Move issues to a sprint, for a given sprint ID. Issues can only be moved to open or active sprints. The maximum number of issues that can be moved in one operation is 50.

NameTypeRequiredDescription

issuesarrayrequiredThe list of issue keys or IDs to move to the sprint

sprintIdintegerrequiredThe ID of the sprint that you want to assign issues to

rankAfterIssuestringoptionalAn issue to rank the moved issues after

rankBeforeIssuestringoptionalAn issue to rank the moved issues before

rankCustomFieldIdintegeroptionalThe ID of the custom field of type 'Rank' used for ranking

jira_sprint_partial_update#Perform a partial update of a sprint. Fields not present in the request are left unchanged. For closed sprints, only name and goal can be updated. A sprint can be started by updating state to 'active' (requires the sprint to be in 'future' state with startDate and endDate set), and completed by updating state to 'closed' (requires the sprint to be 'active'; this sets completeDate to the time of the request). Other state transitions are not allowed, and completeDate cannot be updated manually.8 params▾

Perform a partial update of a sprint. Fields not present in the request are left unchanged. For closed sprints, only name and goal can be updated. A sprint can be started by updating state to 'active' (requires the sprint to be in 'future' state with startDate and endDate set), and completed by updating state to 'closed' (requires the sprint to be 'active'; this sets completeDate to the time of the request). Other state transitions are not allowed, and completeDate cannot be updated manually.

NameTypeRequiredDescription

sprintIdintegerrequiredThe ID of the sprint to update

completeDatestringoptionalComplete date of the sprint. Cannot be set manually.

endDatestringoptionalEnd date of the sprint

goalstringoptionalGoal of the sprint

namestringoptionalName of the sprint

originBoardIdintegeroptionalThe ID of the board that the sprint is created on

startDatestringoptionalStart date of the sprint

statestringoptionalState of the sprint: future, active, or closed

jira_sprint_property_delete#Delete a custom property from a Jira Software sprint by its property key. Returns an empty response if the property was removed successfully.2 params▾

Delete a custom property from a Jira Software sprint by its property key. Returns an empty response if the property was removed successfully.

NameTypeRequiredDescription

propertyKeystringrequiredThe key of the property to remove

sprintIdstringrequiredThe ID of the sprint from which the property will be removed

jira_sprint_property_get#Get the value of a custom property set on a Jira Software sprint by its property key. Returns the property key and its JSON value if the sprint exists and the property was found.2 params▾

Get the value of a custom property set on a Jira Software sprint by its property key. Returns the property key and its JSON value if the sprint exists and the property was found.

NameTypeRequiredDescription

propertyKeystringrequiredThe key of the property to return

sprintIdstringrequiredThe ID of the sprint from which the property will be returned

jira_sprint_property_keys_list#Return the keys of all properties for the sprint identified by the given ID. The user who retrieves the property keys is required to have permission to view the sprint.1 param▾

Return the keys of all properties for the sprint identified by the given ID. The user who retrieves the property keys is required to have permission to view the sprint.

NameTypeRequiredDescription

sprintIdstringrequiredThe ID of the sprint from which property keys will be returned

jira_sprint_property_set#Set or update a custom property on a Jira Software sprint. Properties can store arbitrary JSON values (max 32768 bytes) and are visible to apps and API consumers. The value must be a valid, non-empty JSON value passed as a JSON string. Returns 200 if the property was updated, or 201 if it was created.3 params▾

Set or update a custom property on a Jira Software sprint. Properties can store arbitrary JSON values (max 32768 bytes) and are visible to apps and API consumers. The value must be a valid, non-empty JSON value passed as a JSON string. Returns 200 if the property was updated, or 201 if it was created.

NameTypeRequiredDescription

propertyKeystringrequiredThe key of the sprint's property. The maximum length of the key is 255 bytes.

sprintIdstringrequiredThe ID of the sprint on which the property will be set

valuestringrequiredThe JSON value to store for the property, passed as a JSON string. Must be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes.

jira_sprint_swap#Swap the position of the sprint with the second sprint. Both sprints must exist and be visible to the calling user.2 params▾

Swap the position of the sprint with the second sprint. Both sprints must exist and be visible to the calling user.

NameTypeRequiredDescription

sprintIdintegerrequiredThe ID of the sprint to swap

sprintToSwapWithintegerrequiredThe ID of the sprint to swap with

jira_sprint_update#Perform a full update of a sprint. A full update means the result will be exactly the same as the request body; any fields not present in the request will be set to null. For closed sprints, only name and goal can be updated. A sprint can be started by updating state to 'active' (requires the sprint to be in 'future' state with startDate and endDate set), and completed by updating state to 'closed' (requires the sprint to be 'active'; this sets completeDate to the time of the request). Other state transitions are not allowed, and completeDate cannot be updated manually.8 params▾

Perform a full update of a sprint. A full update means the result will be exactly the same as the request body; any fields not present in the request will be set to null. For closed sprints, only name and goal can be updated. A sprint can be started by updating state to 'active' (requires the sprint to be in 'future' state with startDate and endDate set), and completed by updating state to 'closed' (requires the sprint to be 'active'; this sets completeDate to the time of the request). Other state transitions are not allowed, and completeDate cannot be updated manually.

NameTypeRequiredDescription

sprintIdintegerrequiredThe ID of the sprint to update

completeDatestringoptionalComplete date of the sprint. Cannot be set manually; only meaningful when read back from Jira.

endDatestringoptionalEnd date of the sprint

goalstringoptionalGoal of the sprint

namestringoptionalName of the sprint

originBoardIdintegeroptionalThe ID of the board that the sprint is created on

startDatestringoptionalStart date of the sprint

statestringoptionalState of the sprint: future, active, or closed

jira_status_project_issue_type_usages_list#Get a paginated list of issue types within a specific project that are currently using a given status. Useful for understanding where a status is applied before renaming or deleting it. Requires the status ID and project ID; supports cursor-based pagination via nextPageToken.4 params▾

Get a paginated list of issue types within a specific project that are currently using a given status. Useful for understanding where a status is applied before renaming or deleting it. Requires the status ID and project ID; supports cursor-based pagination via nextPageToken.

NameTypeRequiredDescription

projectIdstringrequiredThe ID of the project to fetch issue type usages for

statusIdstringrequiredThe ID of the status to fetch issue type usages for

maxResultsintegeroptionalThe maximum number of results to return (between 1 and 200). Defaults to 50.

nextPageTokenstringoptionalCursor token for fetching the next page of results. Omit for the first page.

jira_status_project_usages_list#Get a paginated list of projects that are currently using a given status. Useful for understanding the impact of renaming or deleting a status before making the change. Supports cursor-based pagination via nextPageToken.3 params▾

Get a paginated list of projects that are currently using a given status. Useful for understanding the impact of renaming or deleting a status before making the change. Supports cursor-based pagination via nextPageToken.

NameTypeRequiredDescription

statusIdstringrequiredThe ID of the status to fetch project usages for

maxResultsintegeroptionalThe maximum number of results to return (between 1 and 200). Defaults to 50.

nextPageTokenstringoptionalCursor token for fetching the next page of results. Omit for the first page.

jira_status_workflow_usages_list#Get a paginated list of workflows that are currently using a given status. Useful for understanding the impact of renaming or deleting a status before making the change. Supports cursor-based pagination via nextPageToken.3 params▾

Get a paginated list of workflows that are currently using a given status. Useful for understanding the impact of renaming or deleting a status before making the change. Supports cursor-based pagination via nextPageToken.

NameTypeRequiredDescription

statusIdstringrequiredThe ID of the status to fetch workflow usages for

maxResultsintegeroptionalThe maximum number of results to return (between 1 and 200). Defaults to 50.

nextPageTokenstringoptionalCursor token for fetching the next page of results. Omit for the first page.

jira_statuses_by_id_delete#Delete one or more Jira workflow statuses by ID. Accepts between 1 and 50 status IDs. Requires the Administer projects or Administer Jira permission.1 param▾

Delete one or more Jira workflow statuses by ID. Accepts between 1 and 50 status IDs. Requires the Administer projects or Administer Jira permission.

NameTypeRequiredDescription

idarrayrequiredList of status IDs to delete. Minimum 1 item, maximum 50 items.

jira_statuses_by_id_get#Retrieve one or more Jira workflow statuses by ID. Accepts between 1 and 50 status IDs and returns the matching status objects. Requires the Administer projects or Administer Jira permission.1 param▾

Retrieve one or more Jira workflow statuses by ID. Accepts between 1 and 50 status IDs and returns the matching status objects. Requires the Administer projects or Administer Jira permission.

NameTypeRequiredDescription

idarrayrequiredList of status IDs to retrieve. Minimum 1 item, maximum 50 items.

jira_statuses_by_name_get#Look up one or more Jira statuses by their exact name(s). Provide a comma-separated list of 1 to 50 status names and optionally a project ID to scope the search to a specific project (omit for global statuses). Returns matching status details including ID, name, and category. Requires Administer Jira, Administer Projects, or Browse Projects permission.2 params▾

Look up one or more Jira statuses by their exact name(s). Provide a comma-separated list of 1 to 50 status names and optionally a project ID to scope the search to a specific project (omit for global statuses). Returns matching status details including ID, name, and category. Requires Administer Jira, Administer Projects, or Browse Projects permission.

NameTypeRequiredDescription

namestringrequiredComma-separated list of status names to look up (1 to 50 names). Example: 'To Do,In Progress,Done'

projectIdstringoptionalThe ID of the project the statuses belong to. Omit to search global statuses.

jira_statuses_create#Create one or more custom statuses in a Jira global or project scope. Provide a scope (GLOBAL for company-managed projects or PROJECT with a project ID for team-managed projects) and a list of statuses, each with a name and status category (TODO, IN_PROGRESS, or DONE). Requires Administer Jira or Administer Projects permission.3 params▾

Create one or more custom statuses in a Jira global or project scope. Provide a scope (GLOBAL for company-managed projects or PROJECT with a project ID for team-managed projects) and a list of statuses, each with a name and status category (TODO, IN_PROGRESS, or DONE). Requires Administer Jira or Administer Projects permission.

NameTypeRequiredDescription

scope_typestringrequiredThe scope of the statuses being created. Use GLOBAL for company-managed projects or PROJECT for team-managed projects.

statusesarrayrequiredList of statuses to create. Each item must include a name (max 255 chars) and a statusCategory (TODO, IN_PROGRESS, or DONE), and may include an optional description. Example: [{"name": "In Review", "statusCategory": "IN_PROGRESS", "description": "Awaiting review"}]

scope_project_idstringoptionalThe ID of the project the statuses will be scoped to. Required when scope_type is PROJECT; omit for GLOBAL scope.

jira_statuses_search#Search Jira statuses by name or project, returning a paginated list of matching statuses with their IDs, names, and categories. Filter by project ID, a search string matched against status names, or status category (TODO, IN_PROGRESS, DONE). Requires Administer Jira or Administer Projects permission.6 params▾

Search Jira statuses by name or project, returning a paginated list of matching statuses with their IDs, names, and categories. Filter by project ID, a search string matched against status names, or status category (TODO, IN_PROGRESS, DONE). Requires Administer Jira or Administer Projects permission.

NameTypeRequiredDescription

includeGlobalStatusesbooleanoptionalWhether to include global statuses (not tied to any project) in the response. Only relevant for project-scoped queries. Defaults to false.

maxResultsintegeroptionalThe maximum number of items to return per page. Defaults to 200.

projectIdstringoptionalThe ID of the project to search statuses in. Omit to search global statuses.

searchStringstringoptionalTerm to match status names against. Omit to search for all statuses in scope. Max length 255.

startAtintegeroptionalThe index of the first item to return in a page of results (page offset). Defaults to 0.

statusCategorystringoptionalCategory of the status to filter by.

jira_statuses_update#Update one or more existing Jira statuses by ID. Each status object must include the status ID, name, and status category (TODO, IN_PROGRESS, or DONE), and may include a description. Requires Administer Jira or Administer Projects permission.1 param▾

Update one or more existing Jira statuses by ID. Each status object must include the status ID, name, and status category (TODO, IN_PROGRESS, or DONE), and may include a description. Requires Administer Jira or Administer Projects permission.

NameTypeRequiredDescription

statusesarrayrequiredList of statuses to update. Each item must include id, name, and statusCategory (TODO, IN_PROGRESS, or DONE), and may include an optional description. Example: [{"id": "10001", "name": "In Review", "statusCategory": "IN_PROGRESS"}]

jira_time_tracking_configuration_get#Returns the time tracking settings for the Jira site, including the default time format, default time unit, working hours per day, and working days per week. Requires Administer Jira global permission.0 params▾

Returns the time tracking settings for the Jira site, including the default time format, default time unit, working hours per day, and working days per week. Requires Administer Jira global permission.

jira_time_tracking_configuration_set#Sets the time tracking settings for the Jira site: the default time unit applied to logged time, the format shown on an issue's Time Spent field, and the working days per week and hours per day used to convert between units. All four fields are required. Requires Administer Jira global permission.4 params▾

Sets the time tracking settings for the Jira site: the default time unit applied to logged time, the format shown on an issue's Time Spent field, and the working days per week and hours per day used to convert between units. All four fields are required. Requires Administer Jira global permission.

NameTypeRequiredDescription

defaultUnitstringrequiredThe default unit of time applied to logged time.

timeFormatstringrequiredThe format that will appear on an issue's Time Spent field.

workingDaysPerWeeknumberrequiredThe number of days in a working week, used to convert between time units. For example, 5.

workingHoursPerDaynumberrequiredThe number of hours in a working day, used to convert between time units. For example, 8.

jira_time_tracking_implementation_select#Selects the time tracking provider for the Jira site. Requires Administer Jira global permission. The key identifies the provider (e.g. 'JIRA' for the built-in time tracking), and name/url describe it.3 params▾

Selects the time tracking provider for the Jira site. Requires Administer Jira global permission. The key identifies the provider (e.g. 'JIRA' for the built-in time tracking), and name/url describe it.

NameTypeRequiredDescription

keystringrequiredThe key for the time tracking provider, e.g. 'JIRA' for the built-in Jira time tracking provider.

namestringoptionalThe display name of the time tracking provider, e.g. 'JIRA provided time tracking'.

urlstringoptionalThe URL of the configuration page for the time tracking provider app. Only relevant for third-party providers that expose an admin configuration page.

jira_time_tracking_implementations_list#Returns all time tracking providers available on the Jira site. By default Jira only has one time tracking provider, 'JIRA provided time tracking', but additional providers may be installed via Atlassian Marketplace apps. Requires Administer Jira global permission.0 params▾

Returns all time tracking providers available on the Jira site. By default Jira only has one time tracking provider, 'JIRA provided time tracking', but additional providers may be installed via Atlassian Marketplace apps. Requires Administer Jira global permission.

jira_timetracking_config_get#Get the time tracking provider that is currently selected for the Jira instance (e.g. JIRA provider). If time tracking is disabled, a successful but empty response is returned. Requires Administer Jira global permission.0 params▾

Get the time tracking provider that is currently selected for the Jira instance (e.g. JIRA provider). If time tracking is disabled, a successful but empty response is returned. Requires Administer Jira global permission.

jira_trashed_fields_search#Retrieve a paginated list of custom fields that have been moved to the trash. Optionally filter by field ID(s) or by a partial, case-insensitive match on field name or description. Only custom fields are returned. Requires the Administer Jira global permission.6 params▾

Retrieve a paginated list of custom fields that have been moved to the trash. Optionally filter by field ID(s) or by a partial, case-insensitive match on field name or description. Only custom fields are returned. Requires the Administer Jira global permission.

NameTypeRequiredDescription

expandstringoptionalAdditional data to include in the response for each field.

idstringoptionalComma-separated list of custom field IDs to filter by, e.g. customfield_10000,customfield_10001

maxResultsintegeroptionalThe maximum number of items to return per page.

orderBystringoptionalOrder the results by a field: name sorts by field name, trashDate sorts by the date moved to trash, plannedDeletionDate sorts by the planned deletion date. Prefix with - for descending order.

querystringoptionalString used to perform a case-insensitive partial match with field names or descriptions.

startAtintegeroptionalThe index of the first item to return in a page of results (page offset).

jira_user_account_ids_get#Returns the account IDs for users specified by legacy username or key parameters. This is a migration helper for callers still using deprecated username/key identifiers instead of account IDs; provide either usernames or keys (not both). Note: username and key parameters are deprecated by Atlassian and may be removed.4 params▾

Returns the account IDs for users specified by legacy username or key parameters. This is a migration helper for callers still using deprecated username/key identifiers instead of account IDs; provide either usernames or keys (not both). Note: username and key parameters are deprecated by Atlassian and may be removed.

NameTypeRequiredDescription

keyarrayoptionalList of user keys to resolve to account IDs. Required if username isn't provided; cannot be combined with username. Deprecated by Atlassian.

maxResultsintegeroptionalThe maximum number of items to return per page. Default is 10.

startAtintegeroptionalThe index of the first item to return in a page of results (page offset). Default is 0.

usernamearrayoptionalList of usernames to resolve to account IDs. Required if key isn't provided; cannot be combined with key. Deprecated by Atlassian.

jira_user_assignable_search#Find users who can be assigned to issues in a Jira project or specific issue. Provide either projectKey or issueKey (not both). Returns account IDs for use with the Assign Issue tool.5 params▾

Find users who can be assigned to issues in a Jira project or specific issue. Provide either projectKey or issueKey (not both). Returns account IDs for use with the Assign Issue tool.

NameTypeRequiredDescription

issueKeystringoptionalFind users assignable to this specific issue (use instead of projectKey for issue-specific rules)

maxResultsintegeroptionalMaximum number of users to return (default 50)

projectKeystringoptionalFind users assignable to issues in this project

querystringoptionalFilter users by display name, email, or account ID

startAtintegeroptionalIndex of the first user to return (default 0)

jira_user_columns_get#Retrieve the default issue table columns configured for a Jira user. If accountId is omitted, returns the calling user's own default columns. Requires Administer Jira global permission to view another user's columns.1 param▾

Retrieve the default issue table columns configured for a Jira user. If accountId is omitted, returns the calling user's own default columns. Requires Administer Jira global permission to view another user's columns.

NameTypeRequiredDescription

accountIdstringoptionalThe account ID of the user whose default columns should be returned. If omitted, returns the calling user's own columns. Example: 5b10ac8d82e05b22cc7d4ef5

jira_user_columns_reset#Reset the default issue table columns for a Jira user back to the system default. If accountId is omitted, resets the calling user's own default columns. Requires Administer Jira global permission to reset another user's columns.1 param▾

Reset the default issue table columns for a Jira user back to the system default. If accountId is omitted, resets the calling user's own default columns. Requires Administer Jira global permission to reset another user's columns.

NameTypeRequiredDescription

accountIdstringoptionalThe account ID of the user whose default columns should be reset. If omitted, resets the calling user's own columns. Example: 5b10ac8d82e05b22cc7d4ef5

jira_user_columns_set#Set the default issue table columns for a Jira user. If accountId is omitted, sets the calling user's own default columns. If no columns are provided, all default columns are removed. Requires Administer Jira global permission to set another user's columns.2 params▾

Set the default issue table columns for a Jira user. If accountId is omitted, sets the calling user's own default columns. If no columns are provided, all default columns are removed. Requires Administer Jira global permission to set another user's columns.

NameTypeRequiredDescription

accountIdstringoptionalThe account ID of the user whose default columns should be set. If omitted, sets the calling user's own columns. Example: 5b10ac8d82e05b22cc7d4ef5

columnsarrayoptionalList of column keys to set as the user's default issue table columns, in display order. If omitted or empty, all default columns are removed. Example: ["summary", "status", "assignee"]

jira_user_create#Create a new user in Jira by email address, granting access to one or more products. This is a legacy resource retained for compatibility. If the user already exists and has Jira access, returns 201; if they exist but lack access, returns 400. Requires Administer Jira global permission. Does not support Forge apps.2 params▾

Create a new user in Jira by email address, granting access to one or more products. This is a legacy resource retained for compatibility. If the user already exists and has Jira access, returns 201; if they exist but lack access, returns 400. Requires Administer Jira global permission. Does not support Forge apps.

NameTypeRequiredDescription

emailAddressstringrequiredThe email address for the new user.

productsarrayrequiredProducts the new user should have access to. Valid values: jira-core, jira-servicedesk, jira-product-discovery, jira-software. Pass an empty array to create a user with no product access.

jira_user_delete#Permanently remove a user from Jira's user base by their account ID. This does not delete the user's underlying Atlassian account, only their access/record within this Jira site. Requires Site Administration (site-admin group membership). This is a destructive operation and cannot be undone.1 param▾

Permanently remove a user from Jira's user base by their account ID. This does not delete the user's underlying Atlassian account, only their access/record within this Jira site. Requires Site Administration (site-admin group membership). This is a destructive operation and cannot be undone.

NameTypeRequiredDescription

accountIdstringrequiredThe account ID of the user to remove, which uniquely identifies the user across all Atlassian products. Max length 128.

jira_user_email_bulk_get#Retrieve email addresses for multiple users by account ID, regardless of the users' profile visibility settings. Only available to approved Connect apps or Forge apps making asApp() requests.1 param▾

Retrieve email addresses for multiple users by account ID, regardless of the users' profile visibility settings. Only available to approved Connect apps or Forge apps making asApp() requests.

NameTypeRequiredDescription

accountIdarrayrequiredList of account IDs of the users whose email addresses should be returned. Treat each account ID as an opaque identifier. Example: ["5b10ac8d82e05b22cc7d4ef5", "5b10a2844c20165700ede21g"]

jira_user_email_get#Retrieve a single user's email address by account ID, regardless of the user's profile visibility settings. Only available to approved Connect apps or Forge apps making asApp() requests.1 param▾

Retrieve a single user's email address by account ID, regardless of the user's profile visibility settings. Only available to approved Connect apps or Forge apps making asApp() requests.

NameTypeRequiredDescription

accountIdstringrequiredThe account ID of the user whose email address should be returned. Example: 5b10ac8d82e05b22cc7d4ef5

jira_user_get#Get details for a Jira user by their account ID. Returns display name, email address, account type, avatar URLs, and active status.2 params▾

Get details for a Jira user by their account ID. Returns display name, email address, account type, avatar URLs, and active status.

NameTypeRequiredDescription

accountIdstringrequiredThe account ID of the user to retrieve

expandstringoptionalAdditional data to include (e.g. groups,applicationRoles)

jira_user_groups_get#Retrieve the groups that a Jira user belongs to, identified by account ID. Requires the Browse users and groups global permission.1 param▾

Retrieve the groups that a Jira user belongs to, identified by account ID. Requires the Browse users and groups global permission.

NameTypeRequiredDescription

accountIdstringrequiredThe account ID of the user whose group memberships should be returned. Example: 5b10ac8d82e05b22cc7d4ef5

jira_user_keys_by_query_search#Finds Jira users with a structured query and returns a paginated list of user keys (rather than full user details). Takes users in the range defined by startAt and maxResult, up to the thousandth user, and returns only the keys of users matching the structured query.3 params▾

Finds Jira users with a structured query and returns a paginated list of user keys (rather than full user details). Takes users in the range defined by startAt and maxResult, up to the thousandth user, and returns only the keys of users matching the structured query.

NameTypeRequiredDescription

querystringrequiredThe structured search query used to match users, e.g. 'is assignee of PROJ' or a name/email fragment.

maxResultintegeroptionalThe maximum number of items to return per page (default 100).

startAtintegeroptionalThe index of the first item to return in a page of results (page offset), default 0.

jira_users_bulk_get#Retrieve a paginated list of Jira users by their account IDs. Provide one or more account IDs to fetch user details (display name, email, active status) in a single call. Useful for resolving account IDs collected from other tools into full user records.3 params▾

Retrieve a paginated list of Jira users by their account IDs. Provide one or more account IDs to fetch user details (display name, email, active status) in a single call. Useful for resolving account IDs collected from other tools into full user records.

NameTypeRequiredDescription

accountIdarrayrequiredList of account IDs of the users to retrieve. To specify multiple users, provide multiple account ID strings. Example: ["5b10ac8d82e05b22cc7d4ef5", "5b10a2844c20165700ede21g"]

maxResultsintegeroptionalThe maximum number of items to return per page. Default is 10.

startAtintegeroptionalThe index of the first item to return in a page of results (page offset). Default is 0.

jira_users_by_query_search#Finds Jira users with a structured query and returns a paginated list of user details. Takes users in the range defined by startAt and maxResults, up to the thousandth user, and returns only those matching the structured query. To get all users, use the users list tool instead.3 params▾

Finds Jira users with a structured query and returns a paginated list of user details. Takes users in the range defined by startAt and maxResults, up to the thousandth user, and returns only those matching the structured query. To get all users, use the users list tool instead.

NameTypeRequiredDescription

querystringrequiredThe structured search query used to match users, e.g. 'is assignee of PROJ'. Must be valid UQL (User Query Language) syntax — plain name/email text fragments are NOT accepted and will fail with 'Unable to parse UQL'. Use jira_users_search or jira_user_assignable_search for name-based lookups instead.

maxResultsintegeroptionalThe maximum number of items to return per page (default 100).

startAtintegeroptionalThe index of the first item to return in a page of results (page offset), default 0.

jira_users_picker_search#Search for Jira users whose attributes match a query term, formatted for use in a user-picker UI. The response highlights the matched text with HTML strong tags. Optionally excludes specific account IDs from the results and includes avatar URIs.6 params▾

Search for Jira users whose attributes match a query term, formatted for use in a user-picker UI. The response highlights the matched text with HTML strong tags. Optionally excludes specific account IDs from the results and includes avatar URIs.

NameTypeRequiredDescription

querystringrequiredSearch string matched against user attributes such as displayName and emailAddress. Matches on prefix of the attribute value. Example: john

avatarSizestringoptionalThe size of the avatar to return in the response, e.g. xsmall, small, medium, large.

excludeAccountIdsarrayoptionalList of account IDs to exclude from the search results. Example: ["5b10a2844c20165700ede21g", "5b10ac8d82e05b22cc7d4ef5"]

excludeConnectUsersbooleanoptionalWhether to exclude Connect app users from the results. Default is false.

maxResultsintegeroptionalThe maximum number of users to return. The total number of matched users is returned in the response's total field. Default is 50.

showAvatarbooleanoptionalWhether to include the URI to the user's avatar in the response. Default is false.

jira_users_search#Search for Jira users by query string. Returns users whose name, email, or display name matches the query. Useful for finding account IDs to use with other tools.3 params▾

Search for Jira users by query string. Returns users whose name, email, or display name matches the query. Useful for finding account IDs to use with other tools.

NameTypeRequiredDescription

maxResultsintegeroptionalMaximum number of users to return (default 50, max 1000)

querystringoptionalSearch string to match against user display name, email, or account ID

startAtintegeroptionalIndex of the first user to return (default 0)

jira_users_with_browse_permission_search#Returns a list of users who match a search string and who have permission to browse a given issue or any issue in a given project. Provide either issueKey or projectKey to scope the permission check, and optionally query or accountId to filter by user attributes.6 params▾

Returns a list of users who match a search string and who have permission to browse a given issue or any issue in a given project. Provide either issueKey or projectKey to scope the permission check, and optionally query or accountId to filter by user attributes.

NameTypeRequiredDescription

accountIdstringoptionalA query string that is matched exactly against a user's accountId. Required unless query is specified. Max length 128.

issueKeystringoptionalThe issue key to check browse permission against. Required unless projectKey is specified.

maxResultsintegeroptionalThe maximum number of items to return per page (default 50).

projectKeystringoptionalThe project key (case sensitive) to check browse permission against. Required unless issueKey is specified.

querystringoptionalA query string matched against user attributes such as displayName and emailAddress, using prefix matching. For example 'john' matches displayName 'John Smith' or emailAddress 'john@example.com'.

startAtintegeroptionalThe index of the first item to return in a page of results (page offset), default 0.

jira_users_with_permissions_search#Search for Jira users who both match a search string (against displayName/emailAddress) and hold a given set of permissions for a project or issue. If no search string is provided, all users with the specified permissions are returned. Note: the search scans users up to the thousandth match within the startAt/maxResults range, so results may be fewer than maxResults even if more matches exist.7 params▾

Search for Jira users who both match a search string (against displayName/emailAddress) and hold a given set of permissions for a project or issue. If no search string is provided, all users with the specified permissions are returned. Note: the search scans users up to the thousandth match within the startAt/maxResults range, so results may be fewer than maxResults even if more matches exist.

NameTypeRequiredDescription

permissionsstringrequiredComma-separated list of permissions the users must hold. Can be permission keys from Get All Permissions, custom project permissions, or deprecated legacy values (e.g. ASSIGNABLE_USER, ASSIGN_ISSUES). Example: BROWSE_PROJECTS,CREATE_ISSUES

accountIdstringoptionalExact account ID to match against. Required unless query is specified. Example: 5b10ac8d82e05b22cc7d4ef5

issueKeystringoptionalThe issue key to check permissions against (e.g. permission to a specific issue). Example: PROJ-123

maxResultsintegeroptionalThe maximum number of items to return per page. Default is 50.

projectKeystringoptionalThe project key (case sensitive) to check permissions against. Example: PROJ

querystringoptionalSearch string matched against user attributes such as displayName and emailAddress. Matches on prefix of the attribute value. Example: john

startAtintegeroptionalThe index of the first item to return in a page of results (page offset). Default is 0.

jira_version_create#Create a new version (release) in a Jira project. Versions track which release fixed or introduced an issue. Requires Administer Projects permission.7 params▾

Create a new version (release) in a Jira project. Versions track which release fixed or introduced an issue. Requires Administer Projects permission.

NameTypeRequiredDescription

namestringrequiredName of the version (e.g. v1.0, Sprint 5)

projectstringrequiredKey of the project to add the version to

archivedbooleanoptionalWhether to archive this version immediately (default false)

descriptionstringoptionalDescription of the version

releasedbooleanoptionalWhether this version has been released (default false)

releaseDatestringoptionalThe release date in ISO 8601 date format (e.g. 2024-06-30)

startDatestringoptionalThe start date in ISO 8601 date format (e.g. 2024-06-01)

jira_version_delete#Delete a Jira project version. Optionally move unresolved and/or fixed issues to another version before deleting. Requires Administer Projects permission.3 params▾

Delete a Jira project version. Optionally move unresolved and/or fixed issues to another version before deleting. Requires Administer Projects permission.

NameTypeRequiredDescription

idstringrequiredThe version ID to delete

moveAffectedIssuesTostringoptionalVersion ID to move issues with this version as an affected version to

moveFixIssuesTostringoptionalVersion ID to move unresolved issues with this version as a fix version to

jira_version_delete_and_replace#Delete a Jira project version and optionally replace references to it. Alternative versions can be provided to update issues that use the deleted version in fixVersion, affectedVersion, or version-picker custom fields. If no alternatives are given, those fields are simply cleared of the deleted version. Requires Administer Projects permission.4 params▾

Delete a Jira project version and optionally replace references to it. Alternative versions can be provided to update issues that use the deleted version in fixVersion, affectedVersion, or version-picker custom fields. If no alternatives are given, those fields are simply cleared of the deleted version. Requires Administer Projects permission.

NameTypeRequiredDescription

idstringrequiredThe ID of the version to delete

customFieldReplacementListarrayoptionalArray of objects mapping a custom field ID to a replacement version ID, used when a version-picker custom field contains the deleted version. Example: [{"customFieldId": 10001, "moveTo": 10002}]

moveAffectedIssuesTointegeroptionalThe ID of the version to use as a replacement in the affectedVersion field of issues that reference the deleted version

moveFixIssuesTointegeroptionalThe ID of the version to use as a replacement in the fixVersion field of issues that reference the deleted version

jira_version_get#Retrieve details of a Jira project version by its ID, including name, release date, status, and associated project.2 params▾

Retrieve details of a Jira project version by its ID, including name, release date, status, and associated project.

NameTypeRequiredDescription

idstringrequiredThe version ID to retrieve

expandstringoptionalAdditional data to include (e.g. operations, issuesstatus, remotelinks, approvers)

jira_version_move#Modifies a Jira version's sequence within its project, which affects the display order of versions in Jira. Provide either 'after' (the self URL of the version to place this one after) or 'position' (an absolute position: Earlier, Later, First, Last), but not both.3 params▾

Modifies a Jira version's sequence within its project, which affects the display order of versions in Jira. Provide either 'after' (the self URL of the version to place this one after) or 'position' (an absolute position: Earlier, Later, First, Last), but not both.

NameTypeRequiredDescription

idstringrequiredThe ID of the version to be moved.

afterstringoptionalThe URL (self link) of the version after which to place the moved version. Cannot be used together with position.

positionstringoptionalAn absolute position in which to place the moved version. Cannot be used together with after. One of: Earlier, Later, First, Last.

jira_version_related_issue_counts_get#Returns counts of issues related to a Jira version: the number of issues where fixVersion is set to the version, the number where affectedVersion is set to the version, and the number where a version custom field is set to the version.1 param▾

Returns counts of issues related to a Jira version: the number of issues where fixVersion is set to the version, the number where affectedVersion is set to the version, and the number where a version custom field is set to the version.

NameTypeRequiredDescription

idstringrequiredThe ID of the version to retrieve related issue counts for.

jira_version_related_work_create#Creates a related work item for a given Jira version. Only a generic link type of related work can be created via this API; the relatedWorkId is auto-generated and should not be provided. Requires Resolve Issues and Edit Issues project permissions.4 params▾

Creates a related work item for a given Jira version. Only a generic link type of related work can be created via this API; the relatedWorkId is auto-generated and should not be provided. Requires Resolve Issues and Edit Issues project permissions.

NameTypeRequiredDescription

categorystringrequiredThe category of the related work, e.g. a label describing what kind of related work this is.

idstringrequiredThe ID of the version to associate the related work with.

titlestringoptionalThe title of the related work.

urlstringoptionalThe URL of the related work. Required unless this is the native release note related work item (not supported via this API).

jira_version_related_work_list#Returns the related work items associated with a given Jira version, such as release notes or external links tied to the version.1 param▾

Returns the related work items associated with a given Jira version, such as release notes or external links tied to the version.

NameTypeRequiredDescription

idstringrequiredThe ID of the version to list related work items for.

jira_version_unresolved_issue_count_get#Get the total issue count and unresolved issue count for a Jira project version. Useful for checking release readiness before marking a version as released.1 param▾

Get the total issue count and unresolved issue count for a Jira project version. Useful for checking release readiness before marking a version as released.

NameTypeRequiredDescription

idstringrequiredThe ID of the version to get issue counts for

jira_version_update#Update a Jira project version's name, description, release date, or status (released/archived). Requires Administer Projects permission.7 params▾

Update a Jira project version's name, description, release date, or status (released/archived). Requires Administer Projects permission.

NameTypeRequiredDescription

idstringrequiredThe version ID to update

archivedbooleanoptionalWhether this version is archived

descriptionstringoptionalUpdated version description

namestringoptionalUpdated version name

releasedbooleanoptionalWhether this version has been released

releaseDatestringoptionalUpdated release date in ISO 8601 date format (e.g. 2024-07-15)

startDatestringoptionalUpdated start date in ISO 8601 date format (e.g. 2024-06-15)

jira_versions_merge#Merges two Jira project versions. The version specified by id is deleted, and any occurrences of its ID in fixVersion (and affectedVersion/custom fields) are replaced with the moveIssuesTo version ID. This is a destructive operation since it permanently deletes the source version. Consider using Delete and Replace Version instead if you need more control over swapping version values.2 params▾

Merges two Jira project versions. The version specified by id is deleted, and any occurrences of its ID in fixVersion (and affectedVersion/custom fields) are replaced with the moveIssuesTo version ID. This is a destructive operation since it permanently deletes the source version. Consider using Delete and Replace Version instead if you need more control over swapping version values.

NameTypeRequiredDescription

idstringrequiredThe ID of the version to delete (the source version being merged away).

moveIssuesTostringrequiredThe ID of the version to merge into (the destination version that will replace references to id).

jira_workflows_search#Search for workflows in the Jira instance with pagination. Returns workflow names, IDs, statuses, and whether they are system or custom workflows.6 params▾

Search for workflows in the Jira instance with pagination. Returns workflow names, IDs, statuses, and whether they are system or custom workflows.

NameTypeRequiredDescription

expandstringoptionalAdditional data to include (e.g. statuses, transitions)

isActivebooleanoptionalFilter to active (true) or inactive (false) workflows only

maxResultsintegeroptionalMaximum number of workflows to return (default 50)

queryStringstringoptionalFilter workflows by name (partial match)

startAtintegeroptionalIndex of the first workflow to return (default 0)

workflowNamestringoptionalDeprecated, no-op. This field never worked (wrong query param name); use queryString instead. Kept only for backward compatibility with existing callers.

jira_worklogs_by_ids_list#Get worklog details for a list of worklog IDs. Returns up to 1000 worklogs. Only worklogs the caller is permitted to view (marked viewable by all users, or via project role/group permission) are returned.2 params▾

Get worklog details for a list of worklog IDs. Returns up to 1000 worklogs. Only worklogs the caller is permitted to view (marked viewable by all users, or via project role/group permission) are returned.

NameTypeRequiredDescription

idsarrayrequiredA list of worklog IDs to retrieve. Example: [10001, 10002, 10003]

expandstringoptionalUse expand to include additional information about worklogs in the response. Accepts 'properties' to return each worklog's properties.

jira_worklogs_deleted_since_list#Get a list of worklog IDs and delete timestamps for worklogs deleted after a given date and time. Paginated with a limit of 1000 worklogs per page, ordered oldest to youngest; the response includes an until timestamp and a nextPage URL when more results are available. Does not return worklogs deleted during the last 30 seconds.1 param▾

Get a list of worklog IDs and delete timestamps for worklogs deleted after a given date and time. Paginated with a limit of 1000 worklogs per page, ordered oldest to youngest; the response includes an until timestamp and a nextPage URL when more results are available. Does not return worklogs deleted during the last 30 seconds.

NameTypeRequiredDescription

sinceintegeroptionalThe date and time, as a Unix timestamp in milliseconds, after which deleted worklogs are returned. Defaults to 0 (beginning of time).

jira_worklogs_updated_since_list#Get a list of worklog IDs and update timestamps for worklogs updated after a given date and time. Paginated with a limit of 1000 worklogs per page, ordered oldest to youngest; the response includes an until timestamp and a nextPage URL when more results are available. Does not return worklogs updated during the last 30 seconds.2 params▾

Get a list of worklog IDs and update timestamps for worklogs updated after a given date and time. Paginated with a limit of 1000 worklogs per page, ordered oldest to youngest; the response includes an until timestamp and a nextPage URL when more results are available. Does not return worklogs updated during the last 30 seconds.

NameTypeRequiredDescription

expandstringoptionalUse expand to include additional information about worklogs in the response. Accepts 'properties' to return each worklog's properties.

sinceintegeroptionalThe date and time, as a Unix timestamp in milliseconds, after which updated worklogs are returned. Defaults to 0 (beginning of time).