Get Contact

get/v1-beta/contacts/get

This API allows you to get contact details based on the contactId you specified in the query parameter.

Code snippet

curl -X 'GET' \
  'https://api.boldsign.com/v1-beta/contacts/get?id=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 contactClient = new ContactClient(apiClient);
var contactDetails = await contactClient.GetContactAsync("6797a07d-26d7-41fa-b3a8-c8f72378a7a6c_ErZHN").ConfigureAwait(false);
import requests

url = "https://api.boldsign.com/v1-beta/contacts/get?id=6797a07d-26d7-41fa-b3a8-c8f72378a7a6c_ErZHN"

payload={}
headers = {
    "accept": "*/*",
    "X-API-KEY": "{your API key}",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers, data=payload)

print(response.text)
const axios = require('axios');

axios.get('https://api.boldsign.com/v1-beta/contacts/get', {
    params: {
        id:'6797a07d-26d7-41fa-b3a8-c8f72378a7a6c_Zah73',
    },
    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/contacts/get?id=6797a07d-26d7-41fa-b3a8-c8f72378a7a6c_ErZHN', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

Query parameters

idstringRequiredThe Contact ID of the User.

Example response

200 Success

{
  "contactId": "6797a07d-26d7-41fa-b3a8-c8f72378a7a6c_ErZHN",
  "name": "LutherCooper",
  "email": "luthercooper@cubeflakes.com",
  "companyName": "CubeFlakes",
  "jobTitle": "Developer",
  "phoneNumber": {
    "countryCode": "+1",
    "number": "2015550123"
  }
}