Time periods

Get time periods

Returns compact time period records.

get/time_periods

Request

  • Base URL: https://app.asana.com/api/1.0
  • URL: https://app.asana.com/api/1.0/time_periods
  • 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

start_onstring date

ISO 8601 date string

end_onstring date

ISO 8601 date string

workspacestring required

Globally unique identifier for the workspace.

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 requested time periods.

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"
    }
  ],
  "next_page": {
    "offset": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9",
    "path": "/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9",
    "uri": "https://app.asana.com/api/1.0/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9"
  }
}

Changes

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