Create an organization export request

POST

/organization_exports

Organization Exports

This method creates a request to export an Organization. Asana will complete the export at some point after you create the request.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://app.asana.com/api/1.0/organization_exports' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

201 - Example 1

{
  "data": {
    "gid": "12345",
    "resource_type": "task",
    "created_at": "2012-02-22T02:06:58.147Z",
    "download_url": "https://asana-export.s3.amazonaws.com/export-4632784536274-20170127-43246.json.gz?AWSAccessKeyId=xxxxxxxx",
    "organization": {
      "gid": "12345",
      "resource_type": "task",
      "name": "My Company Workspace"
    },
    "state": "started"
  }
}

Request

Body Params application/json

data

object (OrganizationExportRequest)

optional

An organization_export request starts a job to export the complete data of the given Organization.

organization

string

optional

Globally unique identifier for the workspace or organization.

Example:

1331

Examples

Responses

🟢201Successfully created organization export request.

application/json

Body

data

object (OrganizationExportCompact)

optional

An organization_export object represents a request to export the complete data of an Organization in JSON format.

gid

string

read-onlyoptional

Globally unique identifier of the resource, as a string.

Example:

12345

resource_type

string

read-onlyoptional

The base type of this resource.

Example:

task

created_at

string <date-time>

read-onlyoptional

The time at which this resource was created.

Example:

2012-02-22T02:06:58.147Z

download_url

string <uri> | null

read-onlyoptional

Download this URL to retreive the full export of the organization
in JSON format. It will be compressed in a gzip (.gz) container.

Note: May be null if the export is still in progress or
failed. If present, this URL may only be valid for 1 hour from
the time of retrieval. You should avoid persisting this URL
somewhere and rather refresh on demand to ensure you do not keep
stale URLs.

Example:

https://asana-export.s3.amazonaws.com/export-4632784536274-20170127-43246.json.gz?AWSAccessKeyId=xxxxxxxx

organization

object

WorkspaceCompact

optional

A workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.

state

enum<string>

read-onlyoptional

The current state of the export.

Allowed values:

pendingstartedfinishederror

Example:

started

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500

Modified at 2022-09-13 02:00:31

Get a job by id

Get details on an org export request