PlusVibe.ai

List campaigns (deprecated)

GET

https://api.plusvibe.ai/api/v1/campaign/list

Campaign

List of campaigns associated with their workspace

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.plusvibe.ai/api/v1/campaign/list?workspace_id' \
--header 'x-api-key;'

Response Example

200 - Example 1

{
    "id": "66b447598f6dd99f7f7b5c0a",
    "status": "COMPLETED",
    "created_at": "2023-10-20T19:13:34.220Z",
    "name": "Spring 2024 Marketing Campaign",
    "tags": [
        "66d6efa907aed48b1323d01b"
    ],
    "last_lead_sent": "2023-12-05T10:29:48.269Z",
    "last_lead_replied": "2023-12-05T13:13:41.269Z"
}

Request

Query Params

workspace_id

string

required

Workspace ID

Default:

Example:

65f3c92d3dbe5dbb35374a9a

skip

integer

optional

Optional - Offset for pagination

>= 0

Default:

Example:

limit

integer

optional

Optional - Used for pagination (Max 100)

>= 1<= 100

Default:

Example:

Header Params

x-api-key

string

required

Your PlusVibe.ai account's API Key

Default:

Example:

your-api-key

Responses

🟢200OK

application/json

Successful operation

Body

string

required

Example:

66b447598f6dd99f7f7b5c0a

status

string

required

Status of the campaign (ACTIVE, PAUSED, COMPLETED, INACTIVE, ERROR)

Example:

COMPLETED

created_at

string

required

Example:

2023-10-20T19:13:34.220Z

name

string

required

Example:

Spring 2024 Marketing Campaign