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.
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["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 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.custom_types.get_custom_type(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.custom_type_gid | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One of: asana_created_type_identifier, name, status_options, status_options.color, status_options.completion_state, status_options.enabled, status_options.name |
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 | Model | Optional | Expand Get a custom type — response body — data data — Custom Type Response |
$ (allOf 2) | Model | All variants apply | Expand 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
Schemas
Section titled “Schemas”Get a custom type — response body — data data — Custom Type Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a custom type — response body — data data asana created type identifier, gid, name, resource type |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).status_options | JSON | Optional | |
$ (allOf 2).status_options (anyOf 1) | array | Alternative | The available options for the custom type. |
$ (allOf 2).status_options (anyOf 1)[] | Model | Each item | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand 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) | object | All variants apply | |
$ (allOf 2).completion_state | JSON | Optional | |
$ (allOf 2).completion_state (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
$ (allOf 2).enabled | JSON | Optional | |
$ (allOf 2).enabled (anyOf 1) | boolean | Alternative | Whether or not the custom type status option is a selectable value for the custom type. |
$ (allOf 2).enabled (anyOf 2) | null | Alternative | |
$ (allOf 2).color | JSON | Optional | |
$ (allOf 2).color (anyOf 1) | string | Alternative | The color associated with the custom type status option. Defaults to ‘none’. |
$ (allOf 2).color (anyOf 2) | null | Alternative |
Get a custom type — response body — data data asana created type identifier, gid, name, resource type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | <p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>custom_types:read</code></p> Custom Types extend the types of Asana Objects. |
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 custom type. |
asana_created_type_identifier | JSON | Optional | |
asana_created_type_identifier (anyOf 1) | string | Alternative | *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) | null | Alternative |
Get a custom type — response body — data data — sdk__Custom Type 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. Custom Types extend the types of Asana Objects. |
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 custom type. |
asana_created_type_identifier | JSON | Optional | |
asana_created_type_identifier (anyOf 1) | string | Alternative | *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) | null | Alternative | |
status_options | JSON | Optional | |
status_options (anyOf 1) | array | Alternative | The available options for the custom type. |
status_options (anyOf 1)[] | Model | Each item | Expand Get a custom type — response body — data data status options The available options for the custom type item |
status_options (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | <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. |
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 custom type status option. |
Get a custom type — response body — data data status options The available options for the custom type item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier. |
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 custom type status option. |
completion_state | JSON | Optional | |
completion_state (anyOf 1) | string | Alternative | The completion state the custom type status option corresponds to, all custom types must have one ‘Incomplete’ and ‘Complete’ status option. |
completion_state (anyOf 2) | null | Alternative | |
enabled | JSON | Optional | |
enabled (anyOf 1) | boolean | Alternative | Whether or not the custom type status option is a selectable value for the custom type. |
enabled (anyOf 2) | null | Alternative | |
color | JSON | Optional | |
color (anyOf 1) | string | Alternative | The color associated with the custom type status option. Defaults to ‘none’. |
color (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]