Lodol Docs

Jira

API actions for the Jira integration.

Jira

Connect to Jira using an API token to browse projects and manage issues.


Add a comment to a Jira issue.

Post a comment to a Jira issue thread.

Parameters

ParameterTypeRequiredDescription
issue_keystringYesJira issue key to comment on
bodystringYesComment body to post

Response

{
  "comment": {
    "body": "Sample text content",
    "id": "abc123xyz789",
    "issue_key": {
      "id": "abc123",
      "name": "Sample"
    }
  }
}

Create a Jira issue.

Create a new Jira issue with summary, optional description, priority, and assignee.

Parameters

ParameterTypeRequiredDescription
project_keystringYesJira project key to create the issue in
summarystringYesIssue summary/title
descriptionstringNoissue description supporting Jira markup
issue_typestringNoIssue type name
prioritystringNoPriority name to apply
assignee_account_idstringNoaccount ID of the user to assign the issue to

Response

{
  "issue": {
    "id": "abc123xyz789",
    "key": "example_value",
    "self": "example_value"
  }
}

Get a Jira issue.

Fetch Jira issue details including summary and status.

Parameters

ParameterTypeRequiredDescription
issue_keystringYesJira issue key to fetch

Response

{
  "issue": {
    "id": "abc123xyz789",
    "key": "example_value",
    "status": {
      "id": "1",
      "name": "In Progress"
    },
    "summary": "example_value"
  }
}

List Jira projects.

Retrieve accessible Jira projects for the connected account.

Response

{
  "projects": [
    {
      "id": "proj123",
      "key": "PROJ",
      "name": "Development"
    }
  ]
}

List transitions for a Jira issue.

Retrieve available workflow transitions for a Jira issue based on its current status.

Parameters

ParameterTypeRequiredDescription
issue_keystringYesJira issue key to get transitions for

Response

{
  "transitions": [
    {
      "id": "21",
      "name": "In Progress",
      "to": {
        "id": "3",
        "name": "In Progress"
      }
    }
  ]
}

Search Jira issues.

Run a JQL query to find Jira issues.

Parameters

ParameterTypeRequiredDescription
jqlstringYesJQL query string to execute
max_resultsnumberNoMaximum number of results to return (1-100)
next_page_tokenstringNoCursor token for fetching the next page of results

Response

{
  "issues": [
    {
      "id": "item123",
      "key": "PROJ-1",
      "status": {
        "id": "1",
        "name": "To Do"
      },
      "summary": "Sample Task"
    }
  ]
}

Transition a Jira issue.

Move a Jira issue to a new workflow state by transition ID.

Parameters

ParameterTypeRequiredDescription
issue_keystringYesJira issue key to transition
transition_idstringYesTransition ID to apply to the issue

Response

{
  "issue_key": {
    "id": "abc123",
    "name": "Sample"
  },
  "transition_id": {
    "id": "abc123",
    "name": "Sample"
  }
}

On this page