DocuSign.Api.Users.users_get_users

You're seeing just the function users_get_users, go back to DocuSign.Api.Users module for more information.
Link to this function

users_get_users(connection, account_id, opts \\ [])

View Source

Specs

users_get_users(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.UserInformationList.t()} | {:error, Tesla.Env.t()}

Retrieves the list of users for the specified account. Retrieves the list of users for the specified account. The response returns the list of users for the account along with the information about the result set. If the `additional_info` query was added to the endpoint and set to true, the full user information is returned for each user

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :additional_info (String.t): When set to true, the full list of user information is returned for each user in the account.
    • :count (String.t): Number of records to return. The number must be greater than 0 and less than or equal to 100.
    • :email (String.t):
    • :email_substring (String.t): Filters the returned user records by the email address or a sub-string of email address.
    • :group_id (String.t): Filters user records returned by one or more group Id's.
    • :login_status (String.t):
    • :not_group_id (String.t):
    • :start_position (String.t): Starting value for the list.
    • :status (String.t): Indicates the envelope status. Valid values are: completed - The envelope has been completed and all tags have been signed. created - The envelope is created as a draft. It can be modified and sent later. declined - The envelope has been declined by the recipients. delivered - The envelope has been delivered to the recipients. sent - The envelope is sent to the recipients. signed - The envelope has been signed by the recipients. * voided - The envelope is no longer valid and recipients cannot access or sign the envelope.
    • :user_name_substring (String.t): Filters the user records returned by the user name or a sub-string of user name.

Returns

} on success {:error, info} on failure