Asana: Get time tracking categories for a workspace
Asana timeTrackingCategories.getTimeTrackingCategories: arguments, response, policy and SDK examples.
← Time tracking categories operations · Get started
Operation asana.gettimetrackingcategories
Provider route: GET /time_tracking_categories. 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["timeTrackingCategories"]["getTimeTrackingCategories"]>[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.timeTrackingCategories.getTimeTrackingCategories(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_tracking_categories.get_time_tracking_categories(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Required within parent | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.workspace | string | Required within parent | |
query.is_archived | boolean | Optional | |
query.limit | integer | Optional | Minimum: 1 Maximum: 100 |
query.offset | string | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One of: color, is_archived, name, offset, path, uri |
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 | array | Optional | |
$ (allOf 1).data[] | Model | Each item | Expand Get time tracking categories for a workspace — response body — data, next page data item |
$ (allOf 1).next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
$ (allOf 2) | Model | All variants apply | Expand Get time tracking categories for a workspace — response body — data, next page |
Referenced models: Get goals — response body — data, next page next page, Get time tracking categories for a workspace — response body — data, next page data item, Get time tracking categories for a workspace — response body — data, next page
Schemas
Section titled “Schemas”Get goals — response body — data, next page next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | *Conditional*. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed. |
$ (anyOf 1).offset | string | Optional | Pagination offset for the request. Read only: true |
$ (anyOf 1).path | string | Optional | A relative path containing the query parameters to fetch for next_page Read only: true |
$ (anyOf 1).uri | string | Optional | A full uri containing the query parameters to fetch for next_page Format: uri Read only: true |
$ (anyOf 2) | null | Alternative |
Get time tracking categories for a workspace — response body — data, next page data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *time tracking category* is a label that can be assigned to time tracking entries. Categories are workspace-scoped and allow users to classify logged time (e.g., 'Development', 'Meetings'). |
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 |
name | string | Optional | The name of the time tracking category. |
color | string | Optional | The color associated with this category for display purposes. Known values: none, red, orange, yellow-orange, yellow, yellow-green, green, blue-green, aqua, blue, indigo, purple, magenta, hot-pink, pink, cool-gray |
Get time tracking categories for a workspace — response body — data, next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get a time tracking category — response body — data data — sdk__Time Tracking Category Response |
next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
Referenced models: Get goals — response body — data, next page next page, Get a time tracking category — response body — data data — sdk__Time Tracking Category Response
Get a time tracking category — response body — data data — sdk__Time Tracking Category Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *time tracking category* is a label that can be assigned to time tracking entries. Categories are workspace-scoped and allow users to classify logged time (e.g., 'Development', 'Meetings'). |
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 |
name | string | Optional | The name of the time tracking category. |
color | string | Optional | The color associated with this category for display purposes. Known values: none, red, orange, yellow-orange, yellow, yellow-green, green, blue-green, aqua, blue, indigo, purple, magenta, hot-pink, pink, cool-gray |
is_archived | boolean | Optional | Whether the category is archived. Archived categories cannot be assigned to new time entries but remain visible on existing entries. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: asana.gettimetrackingcategories. Catalog operation: asana:getTimeTrackingCategories. 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.
Required provider scopes: ["time_tracking_categories:read"]