Skip to main content
GET
/
v1
/
campaigns
/
{id}
Get campaign by ID
curl --request GET \
  --url https://api.botdog.io/v1/campaigns/{id} \
  --header 'x-api-key: <api-key>'
{
  "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"
}

Authorizations

​
x-api-key
string
header
default:bd_live_your_key_here
required

Path Parameters

​
id
string
required

Response

Return the campaign if found

​
id
string
required

The unique identifier of the campaign

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string
required

The name of the campaign

Example:

"Q4 Sales Outreach"

​
status
enum<string>
required

The current status of the campaign

Available options:
ACTIVE,
PAUSED,
ARCHIVED,
COMPLETED,
CREATED
Example:

"ACTIVE"

​
ownerId
string
required

The ID of the user who owns this campaign

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
ownerEmail
string
required

The email of the user who owns this campaign

Example:

"john.doe@example.com"

​
createdAt
string<date-time>
required

The date the campaign was created

Example:

"2023-09-15T12:00:00Z"

​
updatedAt
string<date-time>
required

The date the campaign was last updated

Example:

"2023-09-16T14:30:00Z"

​
startDate
string<date-time>
required

The date the campaign will start

Example:

"2023-09-15T12:00:00Z"

​
endDate
string<date-time>
required

The date the campaign will end

Example:

"2023-09-15T12:00:00Z"