Get time periods

GET

/time_periods

Returns compact time period records.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://app.asana.com/api/1.0/time_periods?workspace=31326'

Response Example

200 - Example 1

{
    "data": [
        {
            "gid": "12345",
            "resource_type": "task",
            "end_on": "2019-09-14",
            "period": "Q1",
            "start_on": "2019-09-13"
        }
    ]
}

Request

Query Params

start_on

string

optional

ISO 8601 date string

Example:

2019-09-15

end_on

string

optional

ISO 8601 date string

Example:

2019-09-15

workspace

string

required

Globally unique identifier for the workspace.

Example:

31326

Responses

🟢200Successfully retrieved the requested time periods.

application/json

Body

data

array[object (TimePeriodCompact) {5}]

optional

gid

string

read-onlyoptional

Globally unique identifier of the resource, as a string.

Example:

12345

resource_type

string

read-onlyoptional

The base type of this resource.

Example:

task

end_on

string

optional

The localized end date of the time period in YYYY-MM-DD format.

Example:

2019-09-14

period

enum<string>

optional

The cadence and index of the time period. The value is one of: FY, H1, H2, Q1, Q2, Q3, or Q4.

Allowed values:

FYH1H2Q1Q2Q3Q4

Example:

start_on

string

optional

The localized start date of the time period in YYYY-MM-DD format.

Example:

2019-09-13

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500

Modified at 2022-09-13 02:00:32

Get users in a workspace or organization

Get a time period