Copy page
Copy original Markdown fileGet ContactGroup
get/v1/contactGroups/getThis API allows you to get group contact details based on the contact group ID you provide.
Code snippet
curl -X 'GET' \
'https://api.boldsign.com/v1/contactGroups/get?groupId=6797a07d-26d7-41fa-b3a8-c8f72378a7a6c_ErZHN' \
-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 contactgroupDetails = await groupContactClient.GetGroupContactAsync("6797a07d-26d7-41fa-b3a8-c8f72378a7a6c_ErZHN").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) group_contacts = group_contacts_api.get_group_contact(group_id="YOUR_GROUP_ID")
<?php
require_once "vendor/autoload.php";
$config = new BoldSign\Configuration();
$config->setApiKey('YOUR_API_KEY');
$apiInstance = new BoldSign\Api\GroupContactsApi($config);
$result = $apiInstance->getGroupContact("YOUR_GROUP_ID");
import { GroupContactsApi } from "boldsign";
const contactGroupApi = new GroupContactsApi();
contactGroupApi.setApiKey("YOUR_API_KEY");
var contactGroup = await contactGroupApi.getGroupContact("YOUR_GROUP_ID");
ApiClient apiClient = Configuration.getDefaultApiClient();
apiClient.setApiKey("YOUR_API_KEY");
GroupContactsApi groupContactApi = new GroupContactsApi(apiClient);
GetGroupContactDetails groupContactDetails = groupContactApi.getGroupContact("YOUR_GROUP_ID");
Query parameters
| idstringRequired | The ContactGroup ID of the User. |
Example response
200 Success
{
"groupName": "Grouptest",
"groupId": "6797a07d-26d7-41fa-b3a8-c8f72378a7a6c_ErZHN",
"contacts": [
{
"name": "LutherCooper",
"email": "luthercooper@cubeflakes.com"
}
],
"creator": {
"userId": "8797a07d-26d7-41fa-b3a8-c8f72378a7a6c_ErZHN",
"createdBy": "jack@gmail.com"
},
"directories": ["Sales", "Legal"]
}