Skip to content

Asana: Get a custom type

Asana customTypes.getCustomType: arguments, response, policy and SDK examples.

← Custom types operations · Get started

Operation asana.getcustomtype

Provider route: GET /custom_types/{custom_type_gid}. Alter supplies the connection’s credentials and routing.

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["customTypes"]["getCustomType"]>[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.customTypes.getCustomType(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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.custom_types.get_custom_type(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.custom_type_gidstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.opt_prettybooleanOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: asana_created_type_identifier, name, status_options, status_options.color, status_options.completion_state, status_options.enabled, status_options.name

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)objectAll variants apply
$ (allOf 1).dataModelOptionalExpand Get a custom type — response body — data data — Custom Type Response
$ (allOf 2)ModelAll variants applyExpand Get a custom type — response body — data

Referenced models: Get a custom type — response body — data data — Custom Type Response, Get a custom type — response body — data

Get a custom type — response body — data data — Custom Type Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a custom type — response body — data data asana created type identifier, gid, name, resource type
$ (allOf 2)objectAll variants apply
$ (allOf 2).status_optionsJSONOptional
$ (allOf 2).status_options (anyOf 1)arrayAlternativeThe available options for the custom type.
$ (allOf 2).status_options (anyOf 1)[]ModelEach itemExpand Get a custom type — response body — data data status options status options The available options for the custom type item
$ (allOf 2).status_options (anyOf 2)nullAlternative

Referenced models: Get a custom type — response body — data data status options status options The available options for the custom type item, Get a custom type — response body — data data asana created type identifier, gid, name, resource type

Get a custom type — response body — data
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a custom type — response body — data data — sdk__Custom Type Response

Referenced models: Get a custom type — response body — data data — sdk__Custom Type Response

Get a custom type — response body — data data status options status options The available options for the custom type item
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace custom type status option gid, name, resource type gid, name, resource type
$ (allOf 2)objectAll variants apply
$ (allOf 2).completion_stateJSONOptional
$ (allOf 2).completion_state (anyOf 1)stringAlternativeThe completion state the custom type status option corresponds to, all custom types must have one ‘Incomplete’ and ‘Complete’ status option.
$ (allOf 2).completion_state (anyOf 2)nullAlternative
$ (allOf 2).enabledJSONOptional
$ (allOf 2).enabled (anyOf 1)booleanAlternativeWhether or not the custom type status option is a selectable value for the custom type.
$ (allOf 2).enabled (anyOf 2)nullAlternative
$ (allOf 2).colorJSONOptional
$ (allOf 2).color (anyOf 1)stringAlternativeThe color associated with the custom type status option. Defaults to ‘none’.
$ (allOf 2).color (anyOf 2)nullAlternative

Referenced models: Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace custom type status option gid, name, resource type gid, name, resource type

Get a custom type — response body — data data asana created type identifier, gid, name, resource type
FieldTypePresenceDescription and constraints
$objectRoot<p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>custom_types:read</code></p>

Custom Types extend the types of Asana Objects.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the custom type.
asana_created_type_identifierJSONOptional
asana_created_type_identifier (anyOf 1)stringAlternative*Read-only*. A stable identifier present when this custom type was created by Asana as part of an Asana product (for example, a Command ticket type or a Service queue type). `null` for custom types created by users, and for Asana-created types that do not have a public identifier yet. New values may be added over time as Asana products introduce new types; integrations should tolerate unrecognized values.
Known values: COMMAND_TICKET, COMMAND_RELEASE, COMMAND_TEAMSPACE, SERVICE_TICKET, SERVICE_CONVERSATION, SERVICE_QUEUE
Read only: true
asana_created_type_identifier (anyOf 2)nullAlternative
Get a custom type — response body — data data — sdk__Custom Type Response
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
Custom Types extend the types of Asana Objects.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the custom type.
asana_created_type_identifierJSONOptional
asana_created_type_identifier (anyOf 1)stringAlternative*Read-only*. A stable identifier present when this custom type was created by Asana as part of an Asana product (for example, a Command ticket type or a Service queue type). `null` for custom types created by users, and for Asana-created types that do not have a public identifier yet. New values may be added over time as Asana products introduce new types; integrations should tolerate unrecognized values.
Known values: COMMAND_TICKET, COMMAND_RELEASE, COMMAND_TEAMSPACE, SERVICE_TICKET, SERVICE_CONVERSATION, SERVICE_QUEUE
Read only: true
asana_created_type_identifier (anyOf 2)nullAlternative
status_optionsJSONOptional
status_options (anyOf 1)arrayAlternativeThe available options for the custom type.
status_options (anyOf 1)[]ModelEach itemExpand Get a custom type — response body — data data status options The available options for the custom type item
status_options (anyOf 2)nullAlternative

Referenced models: Get a custom type — response body — data data status options The available options for the custom type item

Get a task — response body — data data assignee, assignee section, custom fields, custom type, custom type status option, effective memberships, followers, parent, permalink url, projects, tags, workspace custom type status option gid, name, resource type gid, name, resource type
FieldTypePresenceDescription and constraints
$objectRoot<p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>custom_types:read</code></p>

A generic Asana Resource, containing a globally unique identifier.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the custom type status option.
Get a custom type — response body — data data status options The available options for the custom type item
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the custom type status option.
completion_stateJSONOptional
completion_state (anyOf 1)stringAlternativeThe completion state the custom type status option corresponds to, all custom types must have one ‘Incomplete’ and ‘Complete’ status option.
completion_state (anyOf 2)nullAlternative
enabledJSONOptional
enabled (anyOf 1)booleanAlternativeWhether or not the custom type status option is a selectable value for the custom type.
enabled (anyOf 2)nullAlternative
colorJSONOptional
color (anyOf 1)stringAlternativeThe color associated with the custom type status option. Defaults to ‘none’.
color (anyOf 2)nullAlternative

SDK function policy ID: asana.getcustomtype. Catalog operation: asana:getCustomType. 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: ["custom_types:read"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.