Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.modestringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand 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

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
FieldTypePresenceDescription and constraints
$objectRootOrganization list.
organizationsarrayOptionalA list of organizations of which the authenticated user is a member.
organizations[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootInformation about an individual organization.
accountsarrayOptionalA list of organization accounts.
accounts[]ModelEach itemExpand Returns a list of organizations that the authenticated user belongs to — response body — organizations item accounts item
created_bystringOptionalThe user who created the organization account.
Format: uuid
created_onstringOptionalThe date the organization's account was created.
Format: date-time
default_account_idstringOptionalThe default account ID of the organization.
Format: uuid
default_permission_profile_idJSONOptional
default_permission_profile_id (anyOf 1)integerAlternativeThe default permission profile ID of the organization.
Format: int64
default_permission_profile_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
descriptionstringOptionalA description of the organization.
idstringOptionalThe ID of the organization.
Format: uuid
identity_providersarrayOptionalA list of identity providers for the organization.
identity_providers[]ModelEach itemExpand Returns the list of identity providers for an organization — response body
last_modified_bystringOptionalThe user who last updated the organization's account.
Format: uuid
last_modified_onstringOptionalThe date the organization's account was last updated.
Format: date-time
linksarrayOptionalA list of links for the organization.
links[]ModelEach itemExpand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item
namestringOptionalThe name of the organization.
reserved_domainsarrayOptionalA list of reserved domains for the organization.
reserved_domains[]ModelEach itemExpand Returns the list of reserved domains for the organization — response body — reserved domains item
usersarrayOptionalA list of the organization accounts users.
users[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootInformation about a reserved domain.
host_namestringOptionalThe host name of the reserved domain.
idstringOptionalThe ID of the reserved domain.
Format: uuid
identity_provider_idstringOptionalThe identity provider ID of the reserved domain.
Format: uuid
linksarrayOptionalA list of useful links.
links[]ModelEach itemExpand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item
settingsarrayOptionalA list of settings for the reserved domain.
settings[]ModelEach itemExpand Returns the list of reserved domains for the organization — response body — reserved domains item settings item
statusstringOptionalThe status of the request. One of:

- `unknown`
- `pending`
- `active`
- `deactivated`
- `rejected`
txt_tokenstringOptionalA 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
FieldTypePresenceDescription and constraints
$objectRoot
identity_providersarrayOptional
identity_providers[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootA link to a useful URL.
hrefstringOptionalThe URL of the linked item.
relstringOptionalThe kind of linked item.
Returns a list of organizations that the authenticated user belongs to — response body — organizations item accounts item
FieldTypePresenceDescription and constraints
$objectRootInformation about an account.
external_account_idJSONOptional
external_account_id (anyOf 1)integerAlternativeThe external account ID.
Format: int64
external_account_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringOptionalThe unique ID of the account.
Format: uuid
namestringOptionalThe name of the account.
site_idJSONOptional
site_id (anyOf 1)integerAlternativeThe site ID.
Format: int32
site_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Returns a list of organizations that the authenticated user belongs to — response body — organizations item users item
FieldTypePresenceDescription and constraints
$objectRootAn ID object.
idstringOptionalThe ID.
Format: uuid
Returns the list of reserved domains for the organization — response body — reserved domains item settings item
FieldTypePresenceDescription and constraints
$objectRootA key/value list of settings.
keystringOptionalThe key of the setting.
typestringOptionalThe type of the setting. One of:

- `unknown`
- `guid`
- `text`
- `integer`
- `boolean`
- `datetime`
- `enumeration`
valueobjectOptionalThe value of the setting.
Returns the list of identity providers for an organization — response body — identity providers item
FieldTypePresenceDescription and constraints
$objectRootInformation about a single identity provider.
auto_provision_usersbooleanOptionalWhen **true,** users who use this identity provider are automatically provisioned.
friendly_namestringOptionalThe human-readable name of the identity provider.
idstringOptionalThe unique ID of the identity provider.
Format: uuid
linksarrayOptionalA list of useful URLs.
links[]ModelEach itemExpand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item
saml_20ModelOptionalExpand 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.
typestringOptionalThe 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

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"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.