GET
/
CampaignItem
/
{campaignId}
/
items
Get campaign items with filters
curl --request GET \
  --url https://api.starleads.co/CampaignItem/{campaignId}/items \
  --header 'X-Api-Key: <x-api-key>'
[
  {
    "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,
    "phoneNumber": "<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>"
      }
    ]
  }
]

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.

​
PageSize
integer
default:50

Number of items per page (default: 50).

​
PageNumber
integer
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

​
id
string | null
​
campaignId
string | null
​
createdAt
string<date-time> | null
​
processedAt
string<date-time> | null
​
lastCallDate
string<date-time> | null
​
runningStatus
enum<string>
Available options:
Pending,
Calling,
Processed,
ProcessingResult,
Error
​
attemptCount
integer
​
phoneNumber
string | null
​
nextTryDate
string<date-time>
​
dataBag
object | null
​
result
object
​
isArchived
boolean
​
eventList
object[] | null