List Contacts

get/v1/contacts/list

This API allows you to get a list of contacts 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/contacts/list?PageSize=10&Page=1&SearchKey=xxxx&ContactType=MyContacts' \
  -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 result = await contactClient.ContactList(1,10).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)
    list_contact_response = contacts_api.contact_user_list(page_size=10, page=1)

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

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

$contacts_api = new BoldSign\Api\ContactsApi($config);
$list_contact_response = $contacts_api->contactUserList($page=1, $page_size=10);

ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");
            
ContactsApi contactsApi = new ContactsApi(client);
int page = 1; 
int pageSize = 10;          
ContactsList listContactResponse = contactsApi.contactUserList(page, pageSize, null, null);

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

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

const listContactResponse = contactsApi.contactUserList(1,10);

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 contacts of the searchKey results for a keyword.
ContactTypestring	Type of Contacts such as `MyContacts` and `AllContacts`.

Example response

200 Success

{
  "pageDetails": {
    "pageSize": 10,
    "page": 1,
    "totalRecordsCount": 1
  },
  "result": [
    {
      "id": "e892ea92-xxxx-xxxx-xxxx-bbdbcaa5xxxxc_pgVgo",
      "name": "xxxxx",
      "email": "cooper@cubeflakes.com",
      "companyName": "syncfusion",
      "role": "Engineer",
      "phoneNumber": {
        "countryCode": "+91",
        "number": "xxxxx78901"
      }
    }
  ]
}