List ContactGroups

get/v1/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/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(api_key = "YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:

  group_contacts_api = boldsign.GroupContactsApi(api_client)

  list_contact_response = group_contacts_api.group_contact_list(
      page_size=10,
      page=1,
      contact_type="AllContacts", # or mycontacts
      directories=["directory1"]
  )

<?php
require_once "vendor/autoload.php";
$config = new BoldSign\Configuration();
$config->setApiKey('YOUR_API_KEY');
$apiInstance = new BoldSign\Api\GroupContactsApi($config);
$result = $apiInstance->groupContactList(page: 1, page_size: 10);

import { GroupContactsApi } from "boldsign";

const contactGroupApi = new GroupContactsApi();
contactGroupApi.setApiKey("YOUR_API_KEY");

var page = 1;
var pageSize = 10;
var contactGroups = await contactGroupApi.groupContactList(page, pageSize);

ApiClient apiClient = Configuration.getDefaultApiClient();
apiClient.setApiKey("YOUR_API_KEY");
GroupContactsApi groupContactApi = new GroupContactsApi(apiClient);
GroupContactsList groupContactList = groupContactApi.groupContactList(1,10, null, null, null);

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"]
    }
  ]
}