Asana: Get details on an org export request
Asana organizationExports.getOrganizationExport: arguments, response, policy and SDK examples.
← Organization exports operations · Get started
Operation asana.getorganizationexport
Provider route: GET /organization_exports/{organization_export_gid}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/asana with npm, or alter-sdk-asana with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["organizationExports"]["getOrganizationExport"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.organizationExports.getOrganizationExport(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_asana import AsanaIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.organization_exports.get_organization_export(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.organization_export_gid | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One of: created_at, download_url, organization, organization.name, state |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).data | Model | Optional | Expand Get details on an org export request — response body — data data — Organization Export Compact |
$ (allOf 2) | Model | All variants apply | Expand Get details on an org export request — response body — data |
Referenced models: Get details on an org export request — response body — data data — Organization Export Compact, Get details on an org export request — response body — data
Schemas
Section titled “Schemas”Get details on an org export request — response body — data data — Organization Export Compact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An *organization_export* object represents a request to export the complete data of an Organization in JSON format. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
download_url | JSON | Optional | |
download_url (anyOf 1) | string | Alternative | Download this URL to retrieve 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.* Format: uri Read only: true |
download_url (anyOf 2) | null | Alternative | |
state | string | Optional | The current state of the export. Known values: pending, started, finished, error Read only: true |
organization | Model | Optional | Expand Update a workspace — request body — body data |
Referenced models: Update a workspace — request body — body data
Get details on an org export request — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get details on an org export request — response body — data data — sdk__Organization Export Response |
Referenced models: Get details on an org export request — response body — data data — sdk__Organization Export Response
Update a workspace — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the workspace. |
Get details on an org export request — response body — data data — sdk__Organization Export Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. An *organization_export* object represents a request to export the complete data of an Organization in JSON format. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
download_url | JSON | Optional | |
download_url (anyOf 1) | string | Alternative | Download this URL to retrieve 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.* Format: uri Read only: true |
download_url (anyOf 2) | null | Alternative | |
state | string | Optional | The current state of the export. Known values: pending, started, finished, error Read only: true |
organization | Model | Optional | Expand Get a tag — response body — data data workspace |
Referenced models: Get a tag — response body — data data workspace
Get a tag — response body — data data workspace
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the workspace. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: asana.getorganizationexport. Catalog operation: asana:getOrganizationExport. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.