List signer group

This will help you fetch the list of created signer groups.

Arguments

ParamsDatatypeExplanationAllowed values
row_countint

Number of rows to be retrieved

Integers [1,2,...,n]

start_indexint

Start index

Integers [1,2,...,n]

sort_columnString

Sort column

created_time | modified_time | signing_group_name

sort_orderString

Sort by

ASC | DESC

search_columnString

Search by

signing_group_name

API endpoint

CopiedGET https://sign.zoho.com/api/v1/signgroups

Request example

Copieddata =
{
"page_context":
{
"row_count":10,
"start_index":1,
"search_columns":{},
"sort_column":"signing_group_name","sort_order":"ASC"
}
}

Response example

CopiedResponse example
{
 "code": 0,
 "signing_groups": [
 {
 "signing_group_name": "Test group",
 "signing_group_count": 5,
 "signing_group_id": "5000000005001"
 },
 {
 "signing_group_name": "Test group 2",
 "signing_group_count": 3,
 "signing_group_id": "5000000005015"
 }
 ],
 "message": "List of signer groups retrieved",
 "page_context": {
 "has_more_rows": false,
 "start_index": 1,
 "total_count": 2,
 "sort_order": "ASC",
 "row_count": 2
 },
 "status": "success"
}