DocuSign: Returns the results for single user list export request
DocuSign admin.adminOrganizationExportOrganizationExportGetByExportId: arguments, response, policy and SDK examples.
← Admin operations · Get started
Operation docusign.admin_organizationexport_organizationexport_getbyexportid
Provider route: GET /Management/v2/organizations/{organizationId}/exports/user_list/{exportId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["admin"]["adminOrganizationExportOrganizationExportGetByExportId"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.admin.adminOrganizationExportOrganizationExportGetByExportId(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.admin.admin_organization_export_organization_export_get_by_export_id(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.organizationId | string | Required within parent | Format: uuid |
path.exportId | string | Required within parent | Format: uuid |
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 |
|---|---|---|---|
$ | Model | Root | Expand Creates a user list export request — response body |
Referenced models: Creates a user list export request — response body
Schemas
Section titled “Schemas”Creates a user list export request — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completed | string | Optional | The time and date when the request completed. Null if the request is still in progress. Format: date-time |
created | string | Optional | The time and date the request was created. This is a date in ISO 8601 format. Example: `2019-03-26T19:02:09.8957715Z` Format: date-time |
expires | string | Optional | The time and date when the request expires. Format: date-time |
id | string | Optional | The unique ID of this request. Format: uuid |
last_modified | string | Optional | The time and date when the request was modified. This is typically the same as `created`. Format: date-time |
metadata_url | string | Optional | A pre-configured GET request to get the status of the export. Generally this is the same URI used to access this endpoint. |
number_rows | JSON | Optional | |
number_rows (anyOf 1) | integer | Alternative | The number of rows returned in this request. Format: int64 |
number_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
percent_completed | JSON | Optional | |
percent_completed (anyOf 1) | integer | Alternative | An integer between 0 to 100 (inclusive) that reports the progress of the request. Format: int32 |
percent_completed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
requestor | Model | Optional | Expand Closes external memberships — response body — requestor The user who initiated the request. |
results | array | Optional | An array of results. There is one set of results for each server an account is in. |
results[] | Model | Each item | Expand Creates a user list export request — response body — results item |
selected_accounts | array | Optional | |
selected_accounts[] | Model | Each item | Expand Creates a user list export request — response body — selected accounts item |
selected_domains | array | Optional | |
selected_domains[] | Model | Each item | Expand Creates a user list export request — response body — selected domains item |
size_bytes | JSON | Optional | |
size_bytes (anyOf 1) | integer | Alternative | The size of the request in bytes. Format: int64 |
size_bytes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
status | string | Optional | The status of the request. One of: - `failed` - `in_process` - `queued` - `completed` |
success | boolean | Optional | When **true,** the request succeeded. |
type | string | Optional | The type of export requested. One of: - `organization_domain_users_export`: All users of the reserved domains. - `organization_external_memberships_export`: Users whose email address domain is *not* linked to the organization. - `organization_memberships_export`: Every user in every account in the organization. Users in multiple accounts will appear more than once. - `organization_account_settings_export`: This value only applies to requests to export account settings. |
Referenced models: Creates a user list export request — response body — selected accounts item, Creates a user list export request — response body — selected domains item, Closes external memberships — response body — requestor, Creates a user list export request — response body — results item
Creates a user list export request — response body — selected accounts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Optional | Select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified. Format: uuid |
Creates a user list export request — response body — selected domains item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
domain | string | Optional |
Closes external memberships — response body — requestor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | The email address of the requestor. |
id | string | Optional | The unique ID of the requestor. If `type` is `user`, this is the requestor's user ID. |
name | string | Optional | The name of the requestor. |
type | string | Optional | The type of the requestor. One of: - `user` - `client_app` |
Creates a user list export request — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_details | Model | Optional | Expand Creates a user list export request — response body — results item error details Error results. |
id | string | Optional | The unique ID of the task request. Format: uuid |
number_rows | JSON | Optional | |
number_rows (anyOf 1) | integer | Alternative | The number of rows returned in the result. Format: int64 |
number_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
site_id | JSON | Optional | |
site_id (anyOf 1) | integer | Alternative | The ID of the site the response is for. Format: int32 |
site_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
size_bytes | JSON | Optional | |
size_bytes (anyOf 1) | integer | Alternative | The size of the response in bytes. Format: int64 |
size_bytes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
url | string | Optional | The URL that returns the results as a CSV text stream. |
Referenced models: Creates a user list export request — response body — results item error details
Creates a user list export request — response body — results item error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | string | Optional | The error number. |
error_description | string | Optional | A longer description of the error. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.admin_organizationexport_organizationexport_getbyexportid. Catalog operation: admin:OrganizationExport_OrganizationExport_GetByExportId. 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.
Required provider scopes: ["user_read"]