campaigns

Get campaign

Fetch a single campaign by ID.

get/v1/campaigns/{id}

Request

Base URL: https://api.botdog.co
URL: https://api.botdog.co/v1/campaigns/{id}
Auth: API key in header x-api-key

Path parameters

idstring required

Response

Return the campaign if found

idstring required

The unique identifier of the campaign

namestring required

The name of the campaign

status'ACTIVE' | 'PAUSED' | 'ARCHIVED' | 'COMPLETED' | 'CREATED' required

The current status of the campaign

ownerIdstring required

The ID of the user who owns this campaign

ownerEmailstring required

The email of the user who owns this campaign

createdAtstring date-time required

The date the campaign was created

updatedAtstring date-time required

The date the campaign was last updated

startDatestring date-time required

The date the campaign will start

endDatestring date-time required

The date the campaign will end

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Q4 Sales Outreach",
  "status": "ACTIVE",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerEmail": "john.doe@example.com",
  "createdAt": "2023-09-15T12:00:00Z",
  "updatedAt": "2023-09-16T14:30:00Z",
  "startDate": "2023-09-15T12:00:00Z",
  "endDate": "2023-09-15T12:00:00Z"
}

Changes

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