Sign in
Projects

Get all projects in a workspace

Changed on

<b>Required scope: </b><code>projects:read</code>

Returns the compact project records for all projects in the workspace. Note: This endpoint may timeout for large domains. To fetch projects shared with a specific team, use GET /memberships with member set to the team GID and resource_subtype set to project_membership.

get/workspaces/{workspace_gid}/projects

Request

  • Base URL: https://app.asana.com/api/1.0
  • URL: https://app.asana.com/api/1.0/workspaces/{workspace_gid}/projects
  • 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: projects:read)

Query parameters

limitinteger

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offsetstring

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.

archivedboolean

Only return projects whose archived field takes on the value of this parameter.

opt_fieldsstring[]

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 the requested workspace's projects.

Example response

{
  "data": [
    {
      "gid": "12345",
      "resource_type": "project",
      "name": "Stuff to buy",
      "resource_subtype": "default_project"
    }
  ],
  "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

  • b04e9dcf7c00Revision changes
    • info

      added the enum value custom_field_settings.custom_field.html_text_value to the property items/ of the query request parameter opt_fields