Skip to main content

Get SMS Campaign

Retrieve a single SMS campaign by ID, including its configuration and aggregate statistics.


Endpoint

GET https://api.campaignlark.com/v1/sms-campaigns/:id

Path Parameters

ParameterTypeRequiredDescription
idstringrequiredCampaign ID as a MongoDB ObjectID hex string.

Sample Request

GET https://api.campaignlark.com/v1/sms-campaigns/64f1a2b3c4d5e6f7a8b9c0d1

Response

Success — 200 OK

{
"error": null,
"data": {
"id": "64f1a2b3c4d5e6f7a8b9c0d1",
"workspace_id": 42,
"name": "Summer Sale SMS",
"message": "Summer sale: 20% off today. https://example.com/sale",
"audience": [
{
"type": "ENTIRE_AUDIENCE"
}
],
"status": "DRAFT",
"statistics": {
"sent": 0,
"delivered": 0,
"clicked": 0,
"failed": 0,
"unsubscribed": 0,
"suppressed": 0
},
"created_at": "2025-06-30T12:00:00Z",
"updated_at": "2025-06-30T12:00:00Z"
}
}

The audience object fields are documented in List SMS Campaigns. See the SMS campaign lifecycle for status semantics.


Errors

StatusMessageCause
400Please provide a campaign ID.id is missing.
400We could not find the campaign you are looking for.The ID is malformed or the campaign does not exist in the workspace.