Accounts: getOrganizations

Required scopes: organization_read. Please note that the Org Admin API only returns JSON, not XML.

Request

HTTP request

GET /v2/organizations

Parameters

Parameter NameValueDescription

SDK Method

Accounts::getOrganizations

Definitions

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.OrganizationsResponse

Organization list.

organizations[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.OrganizationResponse]

A list of organizations of which the authenticated user is a member.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.OrganizationResponse

Information about an individual organization.

idstring

The ID of the organization.

namestring

The name of the organization.

descriptionstring

A description of the organization.

default_account_idstring

The default account ID of the organization.

default_permission_profile_idinteger

The default permission profile ID of the organization.

created_onstring

The date the organization's account was created.

created_bystring

The user who created the organization account.

last_modified_onstring

The date the organization's account was last updated.

last_modified_bystring

The user who last updated the organization's account.

accounts[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.OrganizationAccountResponse]

A list of organization accounts.

users[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.OrganizationSimpleIdObject]

A list of the organization accounts users.

reserved_domains[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.DomainResponse]

A list of reserved domains for the organization.

identity_providers[DocuSign.Account.Common.Models.RestApi.Response.IdentityProvidersResponse]

A list of identity providers for the organization.

links[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.LinkResponse]

A list of links for the organization.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.OrganizationAccountResponse

Information about an account.

idstring

The unique ID of the account.

namestring

The name of the account.

external_account_idinteger

The external account ID.

site_idinteger

The site ID.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.OrganizationSimpleIdObject

An ID object.

idstring

The ID.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.DomainResponse

Information about a reserved domain.

idstring

The ID of the reserved domain.

statusstring

The status of the request. One of:

  • unknown
  • pending
  • active
  • deactivated
  • rejected

host_namestring

The host name of the reserved domain.

txt_tokenstring

A token in form of text of the reserved domain.

identity_provider_idstring

The identity provider ID of the reserved domain.

settings[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.SettingResponse]

A list of settings of the reserved domain:

links[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.LinkResponse]

A list of useful links.

DocuSign.Account.Common.Models.RestApi.Response.IdentityProvidersResponse

Information about an identity provider.

idstring

The unique ID of the identity provider.

friendly_namestring

The human-readable name of the identity provider.

auto_provision_usersboolean

If true, users who use this identity provider are automatically provisioned.

typestring

The type of the identity provider. One of:

  • none
  • saml_20
  • saml_11
  • saml_10
  • ws_federation
  • open_id_connect

saml_20DocuSign.Account.Common.Models.RestApi.Response.Saml2IdentityProviderResponse

If type is saml_20, details about the SAML 2.0 response.

links[DocuSign.Account.Common.Models.RestApi.Response.LinkResponse]

List of useful URLs.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.LinkResponse

A link to a useful URL.

relstring

The kind of linked item.

hrefstring

URL of the linked item.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.SettingResponse

A key/value list of settings.

keystring

The key of the setting.

valueobject

The value of the setting.

typestring

The type of the setting. One of:

  • unknown
  • guid
  • text
  • integer
  • boolean
  • datetime
  • enumeration

DocuSign.Account.Common.Models.RestApi.Response.Saml2IdentityProviderResponse
DocuSign.Account.Common.Models.RestApi.Response.LinkResponse

Information about a link.

relstring

The kind of link.

hrefstring

The URL.

DocuSign.Account.Common.Models.RestApi.Response.SettingResponse

A key/value list of settings.

keystring

The key of the setting.

valueobject

The value of the setting.

typestring

The type of the setting. One of:

  • unknown
  • guid
  • text
  • integer
  • boolean
  • datetime
  • enumeration

DocuSign.Account.Common.Models.RestApi.Response.CertificateResponse

idstring

issuerstring

thumbprintstring

expiration_datestring

is_validboolean

links[DocuSign.Account.Common.Models.RestApi.Response.LinkResponse]

DocuSign.Account.Common.Models.RestApi.Response.RequiredAttributeMappingResponse

required_attribute_idinteger

required_attribute_namestring

required_attribute_friendly_namestring

substitute_attribute_namestring

Examples

Generic JSON Response

Response
{
  "organizations": [
    {
      "id": "161cb0d9-6e0d-4d8d-881b-17bcf69fc7b4",
      "name": "Test Organization",
      "default_account_id": "4cb5da93-acf2-40a6-9a5f-4ea869fbd2ac",
      "default_permission_profile_id": 2,
      "created_on": "2019-04-04T22:53:39",
      "created_by": "4d412dcd-758c-454b-8c73-c6dd324d75ae",
      "last_modified_on": "2019-04-04T23:02:18",
      "last_modified_by": "4d412dcd-758c-454b-8c73-c6dd324d75ae",
      "accounts": [
        {
          "id": "4cb5da93-acf2-40a6-9a5f-4ea869fbd2ac",
          "name": "Dev User",
          "external_account_id": 1,
          "site_id": 1
        }
      ],
      "users": [
        {
          "id": "4d412dcd-758c-454b-8c73-c6dd324d75ae"
        }
      ],
      "reserved_domains": [],
      "identity_providers": [],
      "links": [
        {
          "rel": "self",
          "href": "https://api.docusign.net/management/v2/organizations/161cb0d9-6e0d-4d8d-881b-17bcf69fc7b4"
        },
        {
          "rel": "accounts",
          "href": "https:// api.docusign.net /management/v2/organizations/161cb0d9-6e0d-4d8d-881b-17bcf69fc7b4/accounts"
        },
        {
          "rel": "admins",
          "href": "https:// api.docusign.net /management/v2/organizations/161cb0d9-6e0d-4d8d-881b-17bcf69fc7b4/admins"
        },
        {
          "rel": "admin_invitations",
          "href": "https:// api.docusign.net /management/v2/organizations/161cb0d9-6e0d-4d8d-881b-17bcf69fc7b4/admin_invitations"
        }
      ]
    }
  ]
}
Generic XML Request/Response

Request
<Not applicable for Org Admin API />
Response
<Not applicable for Org Admin API />
}} />