Skip to main content
GET
Get a campaign

Authorizations

Authorization
string
header
required

Send either an API token or an OAuth access token as Authorization: Bearer <token>. See the Authentication page for details.

Headers

Privy-Account-Id
string

Target a subaccount instead of the main connected account. Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself.

Path Parameters

id
string
required

The campaign's unique identifier (returned as id in campaign responses). Ids are opaque public strings — a numeric id from a Privy dashboard URL is not a valid API id and will 404; list campaigns and match by title instead.

Response

The message campaign.

data
object

A message campaign — configuration only; send statistics belong to the reporting surface. type discriminates the two families: newsletter (email + SMS broadcasts) and flow (the email/SMS messages a flow sends). Newsletter-only fields (status, send_date, audience) are null for flow campaigns — the flow's trigger decides who receives them and when.