Accessing organization exports
These endpoints are only available to Service Accounts of an Enterprise+ organization.
An organization_export object represents a request to export the complete data of an organization in JSON format.
To export an organization using this API:
- Create an
organization_exportrequest and store the ID that is returned - Request the
organization_exportevery few minutes, until thestatefield contains ‘finished’ - Download the file located at the URL in the
download_urlfield - Exports can take a long time, from several minutes to a few hours for large organizations
OrganizationExportCompact
| Property | Type | Description |
|---|---|---|
gid | string | Globally unique identifier of the resource, as a string. |
resource_type | string | The base type of this resource. |
created_at | string (date-time) | The time at which this resource was created. |
download_url | string (uri) | 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. |
state | string | The current state of the export. Values can be: pending, started, finished, error. |
organization | object | A workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. |
organization.gid | string | Globally unique identifier of the resource, as a string. |
organization.resource_type | string | The base type of this resource. |
organization.name | string | The name of the workspace. |
Example JSON for OrganizationExportCompact:
{
"gid": "12345",
"resource_type": "organization_export",
"created_at": "2012-02-22T02:06:58.147Z",
"download_url": "https://asana-export-us-east-1.s3.us-east-1.amazonaws.com/2563645399633793/domain_export/7588024658887731/download/ domain_export_2563645399633793_7588024658887731_2023018-201726.json.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256& X-Amz-Content-Sha256=xxxxxxxx&X-Amz-Date=xxxxxxxx&X-Amz-Expires=300&X-Amz-Security-Token=xxxxxxxx& X-Amz-Signature=xxxxxxxx&X-Amz-SignedHeaders=host&x-id=GetObject#_=_",
"state": "started",
"organization": {
"gid": "12345",
"resource_type": "workspace",
"name": "My Company Workspace"
}
}
OrganizationExport
| Property | Type | Description |
|---|---|---|
gid | string | Globally unique identifier of the resource, as a string. |
resource_type | string | The base type of this resource. |
created_at | string (date-time) | The time at which this resource was created. |
download_url | string (uri) | 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. |
state | string | The current state of the export. Values can be: pending, started, finished, error. |
organization | object | A workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. |
organization.gid | string | Globally unique identifier of the resource, as a string. |
organization.resource_type | string | The base type of this resource. |
organization.name | string | The name of the workspace. |
Example JSON for OrganizationExport:
{
"gid": "12345",
"resource_type": "organization_export",
"created_at": "2012-02-22T02:06:58.147Z",
"download_url": "https://asana-export-us-east-1.s3.us-east-1.amazonaws.com/2563645399633793/domain_export/7588024658887731/download/ domain_export_2563645399633793_7588024658887731_2023018-201726.json.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256& X-Amz-Content-Sha256=xxxxxxxx&X-Amz-Date=xxxxxxxx&X-Amz-Expires=300&X-Amz-Security-Token=xxxxxxxx& X-Amz-Signature=xxxxxxxx&X-Amz-SignedHeaders=host&x-id=GetObject#_=_",
"state": "started",
"organization": {
"gid": "12345",
"resource_type": "workspace",
"name": "My Company Workspace"
}
}