Atlassian: Get worklogs

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

← Issue worklogs operations · Get started

Operation atlassian.getworklogsforids

Provider route: POST /{cloudId}/rest/api/3/worklog/list. 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"]["getWorklogsForIds"]>[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.getWorklogsForIds(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_worklogs_for_ids(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}$
`query`	object	Optional	Additional keys: not allowed
`query.expand`	string	Optional	Default:
`body`	Model	Required within parent	Expand Get worklogs — request body — body

Referenced models: Get worklogs — request body — body

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
`$`	array	Root
`$[]`	Model	Each item	Expand Add worklog — response body

Referenced models: Add worklog — response body

Schemas

2 more schemas are linked from the tables above, on the schema pages.

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 worklogs — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`ids`	array	Required within parent	A list of worklog IDs. Unique items: true
`ids[]`	integer	Each item	Format: int64

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 — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone

Field	Type	Presence	Description and constraints
`$`	object	Root	User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns unknown and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.
`accountId`	JSON	Optional
`accountId (anyOf 1)`	string	Alternative	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Maximum length: 128
`accountId (anyOf 2)`	null	Alternative
`accountType`	JSON	Optional
`accountType (anyOf 1)`	string	Alternative	The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) Read only: true
`accountType (anyOf 2)`	null	Alternative
`active`	JSON	Optional
`active (anyOf 1)`	boolean	Alternative	Whether the user is active. Read only: true
`active (anyOf 2)`	null	Alternative
`avatarUrls`	JSON	Optional
`avatarUrls (anyOf 1)`	Model	Alternative	Expand Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48 The avatars of the user. Read only: true
`avatarUrls (anyOf 2)`	null	Alternative
`displayName`	JSON	Optional
`displayName (anyOf 1)`	string	Alternative	The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. Read only: true
`displayName (anyOf 2)`	null	Alternative
`emailAddress`	JSON	Optional
`emailAddress (anyOf 1)`	string	Alternative	The email address of the user. Depending on the user’s privacy settings, this may be returned as null. Read only: true
`emailAddress (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Read only: true
`key (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Read only: true
`name (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the user. Read only: true
`self (anyOf 2)`	null	Alternative
`timeZone`	JSON	Optional
`timeZone (anyOf 1)`	string	Alternative	The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. Read only: true
`timeZone (anyOf 2)`	null	Alternative

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

Policy, approvals and errors

SDK function policy ID: atlassian.getworklogsforids. Catalog operation: getworklogsforids. 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