Get Contact

get/v1/contacts/get

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

Code snippet

curl -X 'GET' \
  'https://api.boldsign.com/v1/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 boldsign

configuration = boldsign.Configuration(api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client: 

    contacts_api = boldsign.ContactsApi(api_client)
    get_contact_details_response = contacts_api.get_contact(id="YOUR_CONTACT_ID")

<?php require_once "vendor/autoload.php";

$config = new BoldSign\Configuration();
$config->setApiKey('YOUR_API_KEY');

$contacts_api = new BoldSign\Api\ContactsApi($config);
$get_contact_response = $contacts_api->getContact($id = 'YOUR_CONTACT_ID');

ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");
            
ContactsApi contactsApi = new ContactsApi(client);
ContactsDetails contactDetails = contactsApi.getContact("YOUR_CONTACT_ID");

import { ContactsApi } from "@boldsign/node-sdk";

const contactsApi = new ContactsApi();
contactsApi.setApiKey("YOUR_API_KEY");

const contactDetailsResponse = contactsApi.getContact("YOUR_CONTACT_ID");

Query parameters

idstringRequired

The Contact ID of the user. It can be obtained from the list contacts API or from the web app.

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