Batch API

Submit parallel requests

Make multiple requests in parallel to Asana's API.

post/batch

Request

  • Base URL: https://app.asana.com/api/1.0
  • URL: https://app.asana.com/api/1.0/batch
  • 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)

Query parameters

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.

Request body

Example request

{
  "data": {
    "actions": [
      {
        "relative_path": "/tasks/123",
        "method": "get",
        "data": {
          "assignee": "me",
          "workspace": "1337"
        },
        "options": {
          "limit": 3,
          "fields": [
            "name",
            "notes",
            "completed"
          ]
        }
      }
    ]
  }
}

Response

Successfully completed the requested batch API operations.

Example response

{
  "data": [
    {
      "status_code": 200,
      "headers": {
        "location": "/tasks/1234"
      },
      "body": {
        "data": {
          "gid": "1967",
          "completed": false,
          "name": "Hello, world!",
          "notes": "How are you today?"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 51 revisions of this API.