Get campaign items with filters

Retrieves campaign items with optional filters including status, archived state, and pagination.

GET /CampaignItem/{campaignId}/items

Get campaign items with filters

cURL

curl --request GET \
  --url https://api.starleads.co/CampaignItem/{campaignId}/items \
  --header 'X-Api-Key: <api-key>'

200

[
  {
    "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>"
      }
    ]
  }
]

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

200

application/json

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<int32>

phoneNumber · string | null

nextTryDate · string<date-time>

dataBag · object

Show child attributes

dataBag. {key} · string

result · object

Show child attributes

result. tag · object

Show child attributes

result.tag. id · string | null

result.tag. name · string | null

result.tag. color · string | null

result. conversation · object

Show child attributes

result.conversation. id · string | null

result.conversation. messages · object[] | null

Show child attributes

result.conversation.messages. timestamp · string<date-time> | null

result.conversation.messages. role · string | null

result.conversation.messages. text · string | null

result.conversation.messages. intent · string | null

result. summary · string | null

result. isSystem · boolean

result. metadata · object

Show child attributes

result.metadata. {key} · string

isArchived · boolean

eventList · object[] | null

Show child attributes

eventList. type · enum<string>

Available options: LaunchCall, ResetCall, EndCall, ProcessingResult, Error, PickUp

eventList. date · string<date-time>

eventList. description · string | null