# List identities

{% get /%}
{% path text="/v1/senderIdentities/list" /%}

This 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

{% codetab %}

cURL

```shell
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}'
```

C#

```csharp
var apiClient = new ApiClient("https://api.boldsign.com", "Your_API_Key");

var senderIdentityClient = new SenderIdentityClient(apiClient);

var senderIdentityList = senderIdentityClient.ListSenderIdentities(1);
```

Python

```python
import boldsign

configuration = boldsign.Configuration(host = "https://api.boldsign.com", api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:
    
    sender_identities_api = boldsign.SenderIdentitiesApi(api_client)
    sender_identity_list = sender_identities_api.list_sender_identities(page=1)
```

PHP

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

use BoldSign\Configuration;
use BoldSign\Api\SenderIdentitiesApi;

$config = new Configuration();
$config->setHost('https://api.boldsign.com');
$config->setApiKey('YOUR_API_KEY');

$sender_identities_api = new SenderIdentitiesApi($config);
$sender_identity_list = $sender_identities_api->listSenderIdentities($page = 1);
```

Java

```java
ApiClient client = Configuration.getDefaultApiClient();
client.setBasePath("https://api.boldsign.com");
client.setApiKey("YOUR_API_KEY");
            
SenderIdentitiesApi senderIdentitiesApi = new SenderIdentitiesApi(client);

int page = 1;       
SenderIdentityList senderIdentityList = senderIdentitiesApi.listSenderIdentities(page, null, null, null);
```

NodeJS

```js
import { SenderIdentitiesApi } from "boldsign";

const senderIdentitiesApi = new SenderIdentitiesApi("https://api.boldsign.com");
senderIdentitiesApi.setApiKey("YOUR_API_KEY");

const senderIdentityList = senderIdentitiesApi.listSenderIdentities(1);
```

{% /codetab %}

## Query parameters

{% nestedtable %}

- {% arguments name="pageSize" /%}{% batch datatype="Integer" /%}
- Size of the page to list the existing sender identities.

---

- {% arguments name="page" /%}{% batch datatype="Integer" /%}{% required /%}
- Page index of the sender identities list.

---

- {% arguments name="search" /%}{% batch datatype="String" /%}
- Using the search key, sender identities can be filtered based on properties such as name and email address.

---

- {% arguments name="brandIds" /%}{% batch datatype="array" /%}
- Filter sender identities that were assigned specific brand IDs during creation.

{% /nestedtable %}

## Example response

***200 Success***

```json
{
  "result": [
    {
      "id": "2e96f9ad-xxxx-xxxx-xxxx-3063e73f04f8",
      "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,
        "attachSignedDocument": false
      },
      "metaData": {
        "tenantId": "xxxxx070-xxxx-xxxx-xxxx-757xxxxxxxxx",
        "accountPlan": "Free"
      },
      "locale": "EN"
    }
  ],
  "pageDetails": {
    "pageSize": 10,
    "page": 1,
    "totalRecordsCount": 1,
    "totalPages": 1,
    "sortedColumn": "createdDate",
    "sortDirection": "DESC"
  }
}
```