Skip to main content
GET
/
v1
/
campaigns
Obtener Campañas
curl --request GET \
  --url https://api.jelou.ai/v1/campaigns \
  --header 'Authorization: Basic <encoded-value>'
{
  "message": [
    "<string>"
  ],
  "status": "<string>",
  "data": {
    "results": [
      {
        "id": "<string>",
        "name": "<string>",
        "elementName": "<string>",
        "botId": "<string>",
        "status": "PENDING",
        "totalMessages": 123,
        "deliveredMessages": 123,
        "failedMessages": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "completedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "limit": 123,
      "page": 123,
      "total": 123,
      "offset": 123,
      "totalPages": 123
    }
  }
}

Authorizations

Authorization
string
header
required

Basic authentication using Base64 encoded clientId:clientSecret

Query Parameters

page
integer
default:1
limit
integer
default:10
Required range: x <= 50
botId
string
required
startAt
string<date>
required
endAt
string<date>
required
elementName
string
status
enum<string>
Available options:
COMPLETED,
PENDING,
IN_PROGRESS,
SCHEDULED

Response

Campaigns retrieved successfully

message
string[]
status
string
data
object