Skip to content

Retrieves a campaign by id.

GET
/api/v1/provision/admin/campaigns/{id}
curl --request GET \
--url https://example.com/api/v1/provision/admin/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0
id
required
string format: uuid

OK

A campaign: a named, time-boxed commercial initiative. Entitlements are attributed to campaigns through touches (issuance, manual attach, plan override, add-on grant), and the campaign performance report rolls results up per campaign.

object
id
string format: uuid
name
string
code

URL-safe identifier embedded in signup links. Immutable after creation.

string
description
null | string
isEnabled
boolean
startsAt
null | string format: date-time
endsAt
null | string format: date-time
isRunning

True when the campaign is enabled and the current time is inside its window.

boolean
creationTimeStamp
string format: date-time
lastUpdateTimeStamp
null | string format: date-time
revisionNumber
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/

Not Found

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string