Skip to Content
Bulk & Campaign Messaging

Search bulk SMS jobs

View Markdown (.md)
GET
/api/v1/public/sms/bulk/jobs/search

Filters bulk jobs by job name, status, or date range.

Authorization

headerX-Api-Key<token>

SMS Pro API Key (sk_live_... or sk_test_...)

Query Parameters

q?string

Search job title

status?string
Value in"QUEUED""PROCESSING""COMPLETED""FAILED""CANCELLED"
page?integer
Default0
pageSize?integer
Default20

Response Body

Filtered bulk jobs

application/json
  1. response
status?string
data?array<>
Example Request
curl -X GET 'https://api.smspro.com/api/v1/public/sms/bulk/jobs/search'
Example Response
{  "status": "string",  "data": [    {      "batchId": "string",      "jobName": "string",      "recipientCount": 0,      "status": "string",      "progressPercent": 0,      "sentCount": 0,      "failedCount": 0,      "totalUnits": 0,      "createdAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    }  ]}