Get ContactGroup
get/v1-beta/contactGroups/getThis API allows you to get contactgroup details based on the contactgroupId you specified in the query parameter.
Code snippet
curl -X 'GET' \
'https://api.boldsign.com/v1-beta/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(host="https://api.boldsign.com", api_key="YOUR_API_KEY")
with boldsign.ApiClient(configuration) as api_client:
contactgroups_api = boldsign.ContactGroupsApi(api_client)
get_contactgroup_details_response = contactgroup_api.get_contactgroup(
groupId="YOUR_CONTACT_ID"
)
const axios = require('axios');
axios.get('https://api.boldsign.com/v1-beta/contactGroups/get', {
params: {
groupId:'{Paste your contactgroup ID}',
},
headers: {
accept: '*/*',
'X-API-KEY': '{your API key}',
'Content-Type': 'application/json',
}
}).then((response) => {
console.log(response.data);
});
<?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/get?groupId=6797a07d-26d7-41fa-b3a8-c8f72378a7a6c_ErZHN', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
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"]
}