Skip to main content

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

ParameterTypeRequiredDefaultDescription
pageintegeroptional1Page number.
limitintegeroptional50Items 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

FieldTypeDescription
idintegerUnique sender identity ID.
domain_idintegerThe ID of the domain this identity belongs to.
display_namestringThe display name shown to recipients (e.g. "My Store").
local_partstringThe part before the @ in the email address (e.g. "hello").
domain_namestringThe domain part of the email address (e.g. "example.com").

Pagination

FieldTypeDescription
current_pageintegerThe current page number.
per_pageintegerNumber of items per page.
total_pagesintegerTotal number of pages.
total_countintegerTotal number of items.