Campaigns

Get campaign by ID

Retrieve detailed information about a specific campaign

get/api/v1/campaigns/{id}

Request

Base URL: http://localhost:8080
URL: http://localhost:8080/api/v1/campaigns/{id}
Auth: bearerAuth (a scheme the document does not define)

Path parameters

idstring uuid required

Resource UUID

Response

Success

successtrue required

messagestring

Example response

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Q1 2025 Sales Outreach",
    "description": "Quarterly sales campaign targeting high-value prospects",
    "type": "calls",
    "status": "active",
    "language": "es",
    "timezone": "America/Mexico_City",
    "maxAttemptsPerRun": 3,
    "retryTimesOfDay": [
      "14:30",
      "17:00"
    ],
    "createdAt": "2025-03-10T12:00:00Z",
    "updatedAt": "2025-03-10T15:30:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.