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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.time_period_gid | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One of: display_name, end_on, parent, parent.display_name, parent.end_on, parent.period, parent.start_on, period, start_on |
Response
Section titled “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 |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).data | Model | Optional | Expand Get a time period — response body — data data — Time Period Base |
$ (allOf 2) | Model | All variants apply | Expand 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
Schemas
Section titled “Schemas”Get a time period — response body — data data — Time Period Base
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get time periods — response body — data, next page data item |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).parent | JSON | Optional | |
$ (allOf 2).parent (anyOf 1) | JSON | Alternative | |
$ (allOf 2).parent (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get time periods — response body — data, next page data item |
$ (allOf 2).parent (anyOf 1) (allOf 2) | JSON | All variants apply | |
$ (allOf 2).parent (anyOf 2) | null | Alternative |
Referenced models: Get time periods — response body — data, next page data item
Get a time period — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | <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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
end_on | string | Optional | The localized end date of the time period in `YYYY-MM-DD` format. |
start_on | string | Optional | The localized start date of the time period in `YYYY-MM-DD` format. |
period | string | Optional | The cadence and index of the time period. Known values: FY, H1, H2, Q1, Q2, Q3, Q4 |
display_name | string | Optional | A string representing the cadence code and the fiscal year. |
Get a time period — response body — data data — sdk__Time Period Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
end_on | string | Optional | The localized end date of the time period in `YYYY-MM-DD` format. |
start_on | string | Optional | The localized start date of the time period in `YYYY-MM-DD` format. |
period | string | Optional | The cadence and index of the time period. Known values: FY, H1, H2, Q1, Q2, Q3, Q4 |
display_name | string | Optional | A string representing the cadence code and the fiscal year. |
parent | JSON | Optional | |
parent (anyOf 1) | Model | Alternative | Expand Get a time period — response body — data / data / parent / period: FY, H1, H2, Q1, Q2, Q3, Q4 |
parent (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
end_on | string | Optional | The localized end date of the time period in `YYYY-MM-DD` format. |
start_on | string | Optional | The localized start date of the time period in `YYYY-MM-DD` format. |
period | string | Optional | The cadence and index of the time period. Known values: FY, H1, H2, Q1, Q2, Q3, Q4 |
display_name | string | Optional | A string representing the cadence code and the fiscal year. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.