Sign in
Time periods

Get a time period

Returns the full record for a single time period.

get/time_periods/{time_period_gid}

Request

  • Base URL: https://app.asana.com/api/1.0
  • URL: https://app.asana.com/api/1.0/time_periods/{time_period_gid}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.asana.com/-/oauth_authorize, token URL https://app.asana.com/-/oauth_token)

Query parameters

opt_fieldsstring[]

This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide.

Response

Successfully retrieved the record for a single time period.

Example response

{
  "data": {
    "gid": "12345",
    "resource_type": "time_period",
    "end_on": "2019-09-14",
    "start_on": "2019-09-13",
    "period": "Q1",
    "display_name": "Q1 FY22",
    "parent": {
      "gid": "12345",
      "resource_type": "time_period",
      "end_on": "2019-09-14",
      "start_on": "2019-09-13",
      "period": "Q1",
      "display_name": "Q1 FY22"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.