Create an access request

POST /access_requests

Copy endpoint

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

Submits a new access request for a private object. Currently supports projects and portfolios.

Request Body

application/json required

{ data?:

AccessRequestCreateRequest

A request to create shareable access for a user.

interface AccessRequestCreateRequest {
target: string;
message?: string | null;
}

; }

Responses

201 application/json

Successfully created a new access request.

{ data?:

AccessRequestResponse

A access request object represents a request to access a shareable resource within Asana. It includes the requester's information, approval status, and target resource details.

interface AccessRequestResponse {
gid?: string;
resource_type?: string;
message?: string;
approval_status?: "pending" | "approved" | "denied";
requester?: UserCompact;
target?: AccessRequestTargetIdCompact;
}

; }

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;
}

[];
}

402 application/json

The request was valid, but the queried object or object mutation specified in the request is above your current premium level.

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;
}

[];
}