DocuSign: Returns a list of organizations that the authenticated user belongs to
DocuSign admin.adminOrganizationOrganizationGetListV2: arguments, response, policy and SDK examples.
← Admin operations · Get started
Operation docusign.admin_organization_organization_getlistv2
Provider route: GET /Management/v2/organizations. 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"]["adminOrganizationOrganizationGetListV2"]>[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.adminOrganizationOrganizationGetListV2(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_organization_get_list_v2(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.mode | string | Optional |
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 Returns a list of organizations that the authenticated user belongs to — response body |
Referenced models: Returns a list of organizations that the authenticated user belongs to — response body
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
Returns a list of organizations that the authenticated user belongs to — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Organization list. |
organizations | array | Optional | A list of organizations of which the authenticated user is a member. |
organizations[] | Model | Each item | Expand Returns a list of organizations that the authenticated user belongs to — response body — organizations item |
Referenced models: Returns a list of organizations that the authenticated user belongs to — response body — organizations item
Returns a list of organizations that the authenticated user belongs to — response body — organizations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about an individual organization. |
accounts | array | Optional | A list of organization accounts. |
accounts[] | Model | Each item | Expand Returns a list of organizations that the authenticated user belongs to — response body — organizations item accounts item |
created_by | string | Optional | The user who created the organization account. Format: uuid |
created_on | string | Optional | The date the organization's account was created. Format: date-time |
default_account_id | string | Optional | The default account ID of the organization. Format: uuid |
default_permission_profile_id | JSON | Optional | |
default_permission_profile_id (anyOf 1) | integer | Alternative | The default permission profile ID of the organization. Format: int64 |
default_permission_profile_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
description | string | Optional | A description of the organization. |
id | string | Optional | The ID of the organization. Format: uuid |
identity_providers | array | Optional | A list of identity providers for the organization. |
identity_providers[] | Model | Each item | Expand Returns the list of identity providers for an organization — response body |
last_modified_by | string | Optional | The user who last updated the organization's account. Format: uuid |
last_modified_on | string | Optional | The date the organization's account was last updated. Format: date-time |
links | array | Optional | A list of links for the organization. |
links[] | Model | Each item | Expand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item |
name | string | Optional | The name of the organization. |
reserved_domains | array | Optional | A list of reserved domains for the organization. |
reserved_domains[] | Model | Each item | Expand Returns the list of reserved domains for the organization — response body — reserved domains item |
users | array | Optional | A list of the organization accounts users. |
users[] | Model | Each item | Expand Returns a list of organizations that the authenticated user belongs to — response body — organizations item users item |
Referenced models: Returns the list of reserved domains for the organization — response body — reserved domains item, Returns the list of identity providers for an organization — response body, Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item, Returns a list of organizations that the authenticated user belongs to — response body — organizations item accounts item, Returns a list of organizations that the authenticated user belongs to — response body — organizations item users item
Returns the list of reserved domains for the organization — response body — reserved domains item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a reserved domain. |
host_name | string | Optional | The host name of the reserved domain. |
id | string | Optional | The ID of the reserved domain. Format: uuid |
identity_provider_id | string | Optional | The identity provider ID of the reserved domain. Format: uuid |
links | array | Optional | A list of useful links. |
links[] | Model | Each item | Expand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item |
settings | array | Optional | A list of settings for the reserved domain. |
settings[] | Model | Each item | Expand Returns the list of reserved domains for the organization — response body — reserved domains item settings item |
status | string | Optional | The status of the request. One of: - `unknown` - `pending` - `active` - `deactivated` - `rejected` |
txt_token | string | Optional | A token in form of text of the reserved domain. |
Referenced models: Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item, Returns the list of reserved domains for the organization — response body — reserved domains item settings item
Returns the list of identity providers for an organization — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
identity_providers | array | Optional | |
identity_providers[] | Model | Each item | Expand Returns the list of identity providers for an organization — response body — identity providers item |
Referenced models: Returns the list of identity providers for an organization — response body — identity providers item
Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A link to a useful URL. |
href | string | Optional | The URL of the linked item. |
rel | string | Optional | The kind of linked item. |
Returns a list of organizations that the authenticated user belongs to — response body — organizations item accounts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about an account. |
external_account_id | JSON | Optional | |
external_account_id (anyOf 1) | integer | Alternative | The external account ID. Format: int64 |
external_account_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Optional | The unique ID of the account. Format: uuid |
name | string | Optional | The name of the account. |
site_id | JSON | Optional | |
site_id (anyOf 1) | integer | Alternative | The site ID. Format: int32 |
site_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Returns a list of organizations that the authenticated user belongs to — response body — organizations item users item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An ID object. |
id | string | Optional | The ID. Format: uuid |
Returns the list of reserved domains for the organization — response body — reserved domains item settings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A key/value list of settings. |
key | string | Optional | The key of the setting. |
type | string | Optional | The type of the setting. One of: - `unknown` - `guid` - `text` - `integer` - `boolean` - `datetime` - `enumeration` |
value | object | Optional | The value of the setting. |
Returns the list of identity providers for an organization — response body — identity providers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a single identity provider. |
auto_provision_users | boolean | Optional | When **true,** users who use this identity provider are automatically provisioned. |
friendly_name | string | Optional | The human-readable name of the identity provider. |
id | string | Optional | The unique ID of the identity provider. Format: uuid |
links | array | Optional | A list of useful URLs. |
links[] | Model | Each item | Expand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item |
saml_20 | Model | Optional | Expand Returns the list of identity providers for an organization — response body — identity providers item saml 20 If `type` is `saml_20`, contains details about the SAML 2.0 response. |
type | string | Optional | The type of the identity provider. One of: - `none` - `saml_20` - `saml_11` - `saml_10` - `ws_federation` - `open_id_connect` |
Referenced models: Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item, Returns the list of identity providers for an organization — response body — identity providers item saml 20
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.admin_organization_organization_getlistv2. Catalog operation: admin:Organization_Organization_GetListV2. 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: ["organization_read"]