List Sender Identities
Retrieve a paginated list of all sender identities in the workspace.
Endpoint
GET https://api.campaignlark.com/v1/sender-identities
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | optional | 1 | Page number. |
limit | integer | optional | 50 | Items per page (1–100). |
Sample Request
GET https://api.campaignlark.com/v1/sender-identities?page=1&limit=50
Response
Success — 200 OK
{
"error": null,
"data": {
"sender_identities": [
{
"id": 1,
"domain_id": 1,
"display_name": "My Store",
"local_part": "hello",
"domain_name": "example.com"
}
],
"pagination": {
"current_page": 1,
"per_page": 50,
"total_pages": 1,
"total_count": 1
}
}
}
Sender Identity Object
| Field | Type | Description |
|---|---|---|
id | integer | Unique sender identity ID. |
domain_id | integer | The ID of the domain this identity belongs to. |
display_name | string | The display name shown to recipients (e.g. "My Store"). |
local_part | string | The part before the @ in the email address (e.g. "hello"). |
domain_name | string | The domain part of the email address (e.g. "example.com"). |
Pagination
| Field | Type | Description |
|---|---|---|
current_page | integer | The current page number. |
per_page | integer | Number of items per page. |
total_pages | integer | Total number of pages. |
total_count | integer | Total number of items. |