Get a task for a given custom ID

GET /workspaces/{workspace_gid}/tasks/custom_id/{custom_id}

Copy endpoint

https://app.asana.com/api/1.0

Required scope: tasks:read

Returns a task given a custom ID shortcode.

Parameters

path Path Parameters

Name	Type
`workspace_gid` required Globally unique identifier for the workspace or organization.	string
`custom_id` required Generated custom ID for a task.	string

Responses

200 application/json

Successfully retrieved task for given custom ID.

{ data?:

TaskResponse

type TaskResponse = TaskBase & {
assignee?: UserCompact & null;
assignee_section?: {} & SectionCompact | null & SectionCompact;
custom_fields?: readonly CustomFieldResponse[];
custom_type?: CustomTypeCompact & null;
custom_type_status_option?: CustomTypeStatusOptionCompact & null;
followers?: readonly UserCompact[];
parent?: {} & TaskCompact | null & TaskCompact;
projects?: readonly ProjectCompact[];
tags?: readonly TagCompact[];
workspace?: WorkspaceCompact & {};
permalink_url?: string;
}

; }

Client Errors

400 application/json

This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.

interface ErrorResponse {
errors?:

Error

interface Error {
message?: string;
help?: string;
phrase?: string;
}

[];
}

401 application/json

A valid authentication token was not provided with the request, so the API could not associate a user with the request.

interface ErrorResponse {
errors?:

Error

interface Error {
message?: string;
help?: string;
phrase?: string;
}

[];
}

403 application/json

The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to.

interface ErrorResponse {
errors?:

Error

interface Error {
message?: string;
help?: string;
phrase?: string;
}

[];
}

404 application/json

Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist.

interface ErrorResponse {
errors?:

Error

interface Error {
message?: string;
help?: string;
phrase?: string;
}

[];
}

Server Errors

500 application/json

There was a problem on Asana’s end. In the event of a server error the response body should contain an error phrase. These phrases can be used by Asana support to quickly look up the incident that caused the server error. Some errors are due to server load, and will not supply an error phrase.

interface ErrorResponse {
errors?:

Error

interface Error {
message?: string;
help?: string;
phrase?: string;
}

[];
}