Get all custom types associated with an object
<b>Required scope: </b><code>custom_types:read</code>
Returns a list of all of the custom types associated with an object. Exactly one of project or workspace must be provided as a query parameter. When workspace is provided, all custom types in the workspace are listed, including types created by Asana products. Note that, as in all queries to collections which return compact representation, opt_fields can be used to include more data than is returned in the compact representation. See the documentation for input/output options for more information.
Request
- Base URL: https://app.asana.com/api/1.0
- URL: https://app.asana.com/api/1.0/custom_types
- 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, scopes: custom_types:read)
Query parameters
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 custom types
Example response
{
"data": [
{
"gid": "12345",
"resource_type": "custom_type",
"name": "Bug ticket",
"asana_created_type_identifier": "COMMAND_TICKET",
"status_options": [
{
"gid": "12345",
"resource_type": "custom_type_status_option",
"name": "Solution pending",
"completion_state": "Incomplete",
"enabled": true,
"color": "blue"
}
]
}
],
"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.