Atlassian: Get issue worklogs

Atlassian issueWorklogs.getIssueWorklog: arguments, response, policy and SDK examples.

← Issue worklogs operations · Get started

Operation atlassian.getissueworklog

Provider route: GET /{cloudId}/rest/api/3/issue/{issueIdOrKey}/worklog. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["issueWorklogs"]["getIssueWorklog"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.issueWorklogs.getIssueWorklog(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.issue_worklogs.get_issue_worklog(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.cloudId`	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
`path.issueIdOrKey`	string	Required within parent
`query`	object	Optional	Additional keys: not allowed
`query.startAt`	integer	Optional	Default: 0 Format: int64
`query.maxResults`	integer	Optional	Default: 5000 Format: int32
`query.startedAfter`	integer	Optional	Format: int64
`query.startedBefore`	integer	Optional	Format: int64
`query.expand`	string	Optional	Default:

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Get issue worklogs — response body

Referenced models: Get issue worklogs — response body

Schemas

1 more schema is linked from the tables above, on the schema pages.

Get issue worklogs — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Paginated list of worklog details Additional keys: allowed
`maxResults`	JSON	Optional
`maxResults (anyOf 1)`	JSON	Alternative
`maxResults (anyOf 1) (anyOf 1)`	integer	Alternative	The maximum number of results that could be on the page. Format: int32 Read only: true
`maxResults (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`maxResults (anyOf 2)`	null	Alternative
`startAt`	JSON	Optional
`startAt (anyOf 1)`	JSON	Alternative
`startAt (anyOf 1) (anyOf 1)`	integer	Alternative	The index of the first item returned on the page. Format: int32 Read only: true
`startAt (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`startAt (anyOf 2)`	null	Alternative
`total`	JSON	Optional
`total (anyOf 1)`	JSON	Alternative
`total (anyOf 1) (anyOf 1)`	integer	Alternative	The number of results on the page. Format: int32 Read only: true
`total (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`total (anyOf 2)`	null	Alternative
`worklogs`	JSON	Optional
`worklogs (anyOf 1)`	array	Alternative	List of worklogs. Read only: true
`worklogs (anyOf 1)[]`	Model	Each item	Expand Add worklog — response body
`worklogs (anyOf 2)`	null	Alternative

Referenced models: Add worklog — response body

Add worklog — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a worklog. Additional keys: allowed
`author`	JSON	Optional
`author (anyOf 1)`	Model	Alternative	Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone Details of the user who created the worklog. Read only: true
`author (anyOf 2)`	null	Alternative
`comment`	JSON	Optional
`comment (anyOf 1)`	JSON	Alternative	A comment about the worklog in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or updating a worklog.
`comment (anyOf 2)`	null	Alternative
`created`	JSON	Optional
`created (anyOf 1)`	JSON	Alternative
`created (anyOf 1) (anyOf 1)`	string	Alternative	The datetime on which the worklog was created. Read only: true
`created (anyOf 1) (anyOf 2)`	integer	Alternative
`created (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the worklog record. Read only: true
`id (anyOf 2)`	null	Alternative
`issueId`	JSON	Optional
`issueId (anyOf 1)`	string	Alternative	The ID of the issue this worklog is for. Read only: true
`issueId (anyOf 2)`	null	Alternative
`properties`	JSON	Optional
`properties (anyOf 1)`	array	Alternative	Details of properties for the worklog. Optional when creating or updating a worklog.
`properties (anyOf 1)[]`	Model	Each item	Expand Get user property — response body
`properties (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the worklog item. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative
`started`	JSON	Optional
`started (anyOf 1)`	JSON	Alternative
`started (anyOf 1) (anyOf 1)`	string	Alternative	The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.
`started (anyOf 1) (anyOf 2)`	integer	Alternative
`started (anyOf 2)`	null	Alternative
`timeSpent`	JSON	Optional
`timeSpent (anyOf 1)`	string	Alternative	The time spent working on the issue as days (\#d), hours (\#h), or minutes (\#m or \#). Required when creating a worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is provided.
`timeSpent (anyOf 2)`	null	Alternative
`timeSpentSeconds`	JSON	Optional
`timeSpentSeconds (anyOf 1)`	JSON	Alternative
`timeSpentSeconds (anyOf 1) (anyOf 1)`	integer	Alternative	The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided. Format: int64
`timeSpentSeconds (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`timeSpentSeconds (anyOf 2)`	null	Alternative
`updateAuthor`	JSON	Optional
`updateAuthor (anyOf 1)`	Model	Alternative	Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone Details of the user who last updated the worklog. Read only: true
`updateAuthor (anyOf 2)`	null	Alternative
`updated`	JSON	Optional
`updated (anyOf 1)`	JSON	Alternative
`updated (anyOf 1) (anyOf 1)`	string	Alternative	The datetime on which the worklog was last updated. Read only: true
`updated (anyOf 1) (anyOf 2)`	integer	Alternative
`updated (anyOf 2)`	null	Alternative
`visibility`	JSON	Optional
`visibility (anyOf 1)`	Model	Alternative	Expand Add comment — response body — visibility The group or role to which this item is visible Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.
`visibility (anyOf 2)`	null	Alternative

Referenced models: Get user property — response body, Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone, Add comment — response body — visibility The group or role to which this item is visible

Get user property — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	The key of the property. Required on create and update.
`key (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	JSON	Alternative	The value of the property. Required on create and update.
`value (anyOf 2)`	null	Alternative

Add comment — response body — visibility The group or role to which this item is visible

Field	Type	Presence	Description and constraints
`$`	object	Root	The group or role to which this item is visible. Additional keys: allowed
`identifier`	JSON	Optional
`identifier (anyOf 1)`	JSON	Alternative
`identifier (anyOf 1) (anyOf 1)`	string	Alternative	The ID of the group or the name of the role that visibility of this item is restricted to.
`identifier (anyOf 1) (anyOf 2)`	null	Alternative
`identifier (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	Whether visibility of this item is restricted to a group or role. Known values: group, role
`type (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	string	Alternative	The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use `identifier`.
`value (anyOf 2)`	null	Alternative

Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48

Field	Type	Presence	Description and constraints
`$`	object	Root
`16x16`	JSON	Optional
`16x16 (anyOf 1)`	string	Alternative	The URL of the item's 16x16 pixel avatar. Format: uri
`16x16 (anyOf 2)`	null	Alternative
`24x24`	JSON	Optional
`24x24 (anyOf 1)`	string	Alternative	The URL of the item's 24x24 pixel avatar. Format: uri
`24x24 (anyOf 2)`	null	Alternative
`32x32`	JSON	Optional
`32x32 (anyOf 1)`	string	Alternative	The URL of the item's 32x32 pixel avatar. Format: uri
`32x32 (anyOf 2)`	null	Alternative
`48x48`	JSON	Optional
`48x48 (anyOf 1)`	string	Alternative	The URL of the item's 48x48 pixel avatar. Format: uri
`48x48 (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getissueworklog. Catalog operation: getissueworklog. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["read:jira-work"]

Official provider source

Report an issue with this page