List identities
get/v1/senderIdentities/listThis API lists the details of all the existing sender identities under your BoldSign organization account. The sender identity details like name, email address, approval status, approved date, etc., will be displayed.
Code snippet
curl -X 'GET' \ 'https://api.boldsign.com/v1/senderIdentities/list?PageSize=10&Page=1' \ -H 'accept: application/json' \ -H 'X-API-KEY: {your API key}'
var apiClient = new ApiClient("https://api.boldsign.com", "{your API key}"); var senderIdentityClient = new SenderIdentityClient(apiClient); var senderIdentities = senderIdentityClient.ListSenderIdentities(1, 10);
import requests url = "https://api.boldsign.com/v1/senderIdentities/list?PageSize=10&Page=1" payload={} headers = { 'accept': 'application/json', 'X-API-KEY': '{your API key}' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
const axios = require('axios'); const response = await axios.get('https://api.boldsign.com/v1/senderIdentities/list', { params: { 'PageSize': '10', 'Page': '1' }, headers: { 'accept': 'application/json', 'X-API-KEY': '{your API key}' } });
Query parameters
pageSizeInteger | Size of the page to list the existing sender identities. |
pageIntegerRequired | Page index of the sender identities list. |
searchString | Using the search key, sender identities can be filtered based on properties such as name and email address. |
brandIdsarray | Filter sender identities that were assigned specific brand IDs during creation. |
Example response
200 Success
{ "result": [ { "name": "Luther Cooper", "email": "luthercooper@cubeflakes.com", "status": "Pending", "createdBy": "516f5251-xxxx-xxxx-xxxx-04b5e34c5968", "approvedDate": "", "redirectUrl": "https://boldsign.com", "brandId": "c94d34e9-8f1f-4ab1-926d-daa32095a851", "notificationSettings": { "viewed": true, "sent": false, "deliveryFailed": true, "declined": true, "revoked": true, "reassigned": true, "completed": true, "signed": true, "expired": true, "authenticationFailed": true, "reminders": true } } ], "pageDetails": { "pageSize": 10, "page": 1, "totalRecordsCount": 1, "totalPages": 1, "sortedColumn": "createdDate", "sortDirection": "DESC" } }