Skip to main content
GET
/
CampaignItem
/
{campaignId}
/
items
Get campaign items with filters
curl --request GET \
  --url https://api.starleads.co/CampaignItem/{campaignId}/items \
  --header 'X-Api-Key: <api-key>'
{
  "currentPage": 123,
  "totalPages": 123,
  "pageSize": 123,
  "totalCount": 123,
  "items": [
    {
      "id": "<string>",
      "campaignId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "processedAt": "2023-11-07T05:31:56Z",
      "lastCallDate": "2023-11-07T05:31:56Z",
      "runningStatus": "Pending",
      "attemptCount": 123,
      "channel": "Phone",
      "phoneNumber": "<string>",
      "businessId": "<string>",
      "nextTryDate": "2023-11-07T05:31:56Z",
      "dataBag": {},
      "result": {
        "tag": {
          "id": "<string>",
          "name": "<string>",
          "color": "<string>"
        },
        "conversation": {
          "id": "<string>",
          "messages": [
            {
              "timestamp": "2023-11-07T05:31:56Z",
              "role": "<string>",
              "text": "<string>",
              "intent": "<string>"
            }
          ]
        },
        "summary": "<string>",
        "isSystem": true,
        "metadata": {}
      },
      "isArchived": true,
      "eventList": [
        {
          "type": "LaunchCall",
          "date": "2023-11-07T05:31:56Z",
          "description": "<string>"
        }
      ]
    }
  ]
}

Authorizations

X-Api-Key
string
header
required

Headers

X-Api-Key
string
required

Api key to pass as a X-Api-Key request header. You can get yours in your profile when authenticated in Starleads

Path Parameters

campaignId
string
required

ID of the campaign.

Query Parameters

RunningStatusList
enum<string>[]

Optional list of running statuses to filter items.

Available options:
Pending,
Calling,
Processed,
ProcessingResult,
Error
PageSize
integer<int32>
default:50

Number of items per page (default: 50).

PageNumber
integer<int32>
default:1

Page number to retrieve (default: 1).

StartLastCallDate
string<date-time>

Filter items with LastCallDate greater than or equal to this date.

EndLastCallDate
string<date-time>

Filter items with LastCallDate less than or equal to this date.

Response

Success

Paginated result containing campaign items.

currentPage
integer<int32>

Current page number.

totalPages
integer<int32>

Total number of pages.

pageSize
integer<int32>

Number of items per page.

totalCount
integer<int32>

Total number of items across all pages.

items
object[]

List of campaign items for the current page.