docusign.groups.get-groups

Gets information about groups associated with the account. <ds-inlinemessage kind="information" markdown="1"> To get the users in a group: 1. Use this endpoint to get the group ID. 2. Use listGroupUsers to get the list of users. </ds-inlinemessage> ### Related topics - How to set a permission profile

Gets information about groups associated with the account.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
`base_url`	string	Yes	—	Docusign API root, e.g. https://<host>/api
`api_token`	string	No	—	Bearer token; omit to use the workflow's token env var
`accountid`	string	Yes	—	The external account number (int) or account ID GUID.
`count`	string	No	—	The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`
`group_type`	string	No	—	The type of group to return. Valid values: * `AdminGroup` * `CustomGroup` * `EveryoneGroup`
`include_usercount`	string	No	—	When true, every group returned in the response includes a `userCount` property that contains the total number of users in the group. The default is true.
`search_text`	string	No	—	Filters the results of a GET request based on the text that you specify.
`start_position`	string	No	—	The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.

Output Schema

Field	Type	Required	Default	Description
`base_url`	string	Yes	—	Docusign API root, e.g. https://<host>/api
`api_token`	string	No	—	Bearer token; omit to use the workflow's token env var
`accountid`	string	Yes	—	The external account number (int) or account ID GUID.
`count`	string	No	—	The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`
`group_type`	string	No	—	The type of group to return. Valid values: * `AdminGroup` * `CustomGroup` * `EveryoneGroup`
`include_usercount`	string	No	—	When true, every group returned in the response includes a `userCount` property that contains the total number of users in the group. The default is true.
`search_text`	string	No	—	Filters the results of a GET request based on the text that you specify.
`start_position`	string	No	—	The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default value is `0`.
`status_code`	integer	No	—	HTTP status code of the completed call
`response`	json	No	—	Parsed JSON response body
`failure_reason`	string	No	—	—
`failure_type`	string	No	—	—
`failed_at`	string	No	—	—
`failed_step`	string	No	—	—
`failed_layer`	string	No	—	—
`failed_at_state`	string	No	—	—
`error`	string	No	—	—
`error_type`	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
`pending`	Yes	No	—	`execute`	Waiting to call GET /v2.1/accounts/{accountId}/groups
`completed`	No	Yes	Yes	—	HTTP call succeeded
`failed`	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
`pending`	`execute`	`completed`	Perform GET /v2.1/accounts/{accountId}/groups
`*` (any state)	`fail`	`failed`	Record the failure reason

API Usage

bash

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.groups.get-groups",
  "initial_data": {
    "base_url": "value",
    "accountid": "value"
  }
}

docusign.groups.get-groups ​

Overview ​

Input Schema ​

Output Schema ​

States ​

State Diagram ​

Transitions ​

API Usage ​