Skip to content

Asana: Get a time period

Asana timePeriods.getTimePeriod: arguments, response, policy and SDK examples.

← Time periods operations · Get started

Operation asana.gettimeperiod

Provider route: GET /time_periods/{time_period_gid}. Alter supplies the connection’s credentials and routing.

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

import { App } from "@alter-ai/sdk";
import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["timePeriods"]["getTimePeriod"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.timePeriods.getTimePeriod(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_asana import AsanaIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.time_periods.get_time_period(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.time_period_gidstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.opt_prettybooleanOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: display_name, end_on, parent, parent.display_name, parent.end_on, parent.period, parent.start_on, period, start_on

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)objectAll variants apply
$ (allOf 1).dataModelOptionalExpand Get a time period — response body — data data — Time Period Base
$ (allOf 2)ModelAll variants applyExpand Get a time period — response body — data

Referenced models: Get a time period — response body — data data — Time Period Base, Get a time period — response body — data

Get a time period — response body — data data — Time Period Base
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get time periods — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).parentJSONOptional
$ (allOf 2).parent (anyOf 1)JSONAlternative
$ (allOf 2).parent (anyOf 1) (allOf 1)ModelAll variants applyExpand Get time periods — response body — data, next page data item
$ (allOf 2).parent (anyOf 1) (allOf 2)JSONAll variants apply
$ (allOf 2).parent (anyOf 2)nullAlternative

Referenced models: Get time periods — response body — data, next page data item

Get a time period — response body — data
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a time period — response body — data data — sdk__Time Period Response

Referenced models: Get a time period — response body — data data — sdk__Time Period Response

Get time periods — response body — data, next page data item
FieldTypePresenceDescription and constraints
$objectRoot<p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>time_periods:read</code></p>

A generic Asana Resource, containing a globally unique identifier.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
end_onstringOptionalThe localized end date of the time period in `YYYY-MM-DD` format.
start_onstringOptionalThe localized start date of the time period in `YYYY-MM-DD` format.
periodstringOptionalThe cadence and index of the time period.
Known values: FY, H1, H2, Q1, Q2, Q3, Q4
display_namestringOptionalA string representing the cadence code and the fiscal year.
Get a time period — response body — data data — sdk__Time Period Response
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
end_onstringOptionalThe localized end date of the time period in `YYYY-MM-DD` format.
start_onstringOptionalThe localized start date of the time period in `YYYY-MM-DD` format.
periodstringOptionalThe cadence and index of the time period.
Known values: FY, H1, H2, Q1, Q2, Q3, Q4
display_namestringOptionalA string representing the cadence code and the fiscal year.
parentJSONOptional
parent (anyOf 1)ModelAlternativeExpand Get a time period — response body — data / data / parent / period: FY, H1, H2, Q1, Q2, Q3, Q4
parent (anyOf 2)nullAlternative

Referenced models: Get a time period — response body — data / data / parent / period: FY, H1, H2, Q1, Q2, Q3, Q4

Get a time period — response body — data / data / parent / period: FY, H1, H2, Q1, Q2, Q3, Q4
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
end_onstringOptionalThe localized end date of the time period in `YYYY-MM-DD` format.
start_onstringOptionalThe localized start date of the time period in `YYYY-MM-DD` format.
periodstringOptionalThe cadence and index of the time period.
Known values: FY, H1, H2, Q1, Q2, Q3, Q4
display_namestringOptionalA string representing the cadence code and the fiscal year.

SDK function policy ID: asana.gettimeperiod. Catalog operation: asana:getTimePeriod. 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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.