List ContactGroups

get/v1-beta/contactGroups/list

This API allows you to get a list of contactgroups with access to the specified account. If a searchKey query is added to this API, you will get a response based on the searchKey keyword.

Code snippet

curl -X 'GET' \
  'https://api.boldsign.com/v1-beta/contactGroups/list?PageSize=10&Page=1&SearchKey=xxxx&ContactType=MyContacts&Directories=Sales,Legal' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: {your API key}'

// accessing metadata property requires beta version of the SDK at least v4.10.18-beta
var apiClient = new ApiClient("https://api.boldsign.com", "apikey");
var groupContactClient = new GroupContactClient(apiClient);
var result = await groupContactClient.ListGroupContactsAsync(1, 10).ConfigureAwait(false);

import boldsign

configuration = boldsign.Configuration(host="https://api.boldsign.com", api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:  

    contactgroups_api = boldsign.ContactGroupsApi(api_client)
    
    list_contactgroup_response = contactgroups_api.contactgroup_user_list(
        page_size=10,
        page=1,
        directories=["Sales", "Legal"]
    )

const axios = require('axios');
async function fetchData() {
        const response = await axios.get('https://api.boldsign.com/v1-beta/contactGroups/list', {
            params: {
                PageSize: '10',
                Page: '1',
                SearchKey: '',
                ContactType: 'AllContacts',
                Directories: 'Sales,Legal',
            },
            headers: {
                accept: 'application/json',
                'X-API-KEY': 'your API key',
            },
        });

        console.log(JSON.stringify(response.data));
    }
fetchData();

<?php
require_once "vendor/autoload.php";
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;

$client = new Client();

$headers = [
  'accept' => 'application/json',
  'X-API-KEY' => '{your API key}'
];
$request = new Request('GET', 'https://api.boldsign.com/v1-beta/contactGroups/list?PageSize=10&Page=1&SearchKey=xxxx&ContactType=MyContacts&Directories=Sales,Legal', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

Request body

PageSizeinteger	The number of results returned per page. The value must be between 1 and 100. The default value is 10.
PageintegerRequired	The page number of the contact page to return.
SearchKeystring	Returns contactgroups of the searchKey results for a keyword.
ContactTypestring	Type of Contacts such as `MyContacts` and `AllContacts`.
Directoriesstring	Group Contacts can be listed by the search based on the directories.

Example response

200 Success

{
  "pageDetails": {
    "pageSize": 10,
    "page": 1,
    "totalRecordsCount": 1,
  },
  "result": [
    {
      "groupName": "testgroup1",
      "groupId": "e892ea92-xxxx-xxxx-xxxx-bbdbcaa5xxxxc_pgVgo",
      "contacts": [
        {
          "name": "xxxxx",
          "email": "cooper@cubeflakes.com"
        }
      ],
      "directories": ["Sales", "Legal"]
    }
  ]
}