Sign in

v1

latestOpenAPI 3.1.12026-07-14355311.4 MB
Campaign

Read Campaign

Read an existing 'Campaign' record.

get/Campaign/{id}

Response

Success.

idstring

An ID.

namestring

A one-line string.

status'Planning' | 'Active' | 'Inactive' | 'Complete'
type'Email' | 'Newsletter' | 'Informational Email' | 'Web' | 'Television' | 'Radio' | 'Mail'
startDatestring date nullable

A date.

endDatestring date nullable

A date.

descriptionstring nullable

A multi-line text.

createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

targetListsIdsstring[] nullable

IDs of records of the TargetList type.

targetListsNamesobject nullable

An {ID => record name} map.

excludingTargetListsIdsstring[] nullable

IDs of records of the TargetList type.

excludingTargetListsNamesobject nullable

An {ID => record name} map.

sentCountinteger nullable
openedCountinteger nullable
clickedCountinteger nullable
optedInCountinteger nullable
optedOutCountinteger nullable
bouncedCountinteger nullable
hardBouncedCountinteger nullable
softBouncedCountinteger nullable
leadCreatedCountinteger nullable
revenuenumber nullable

A currency amount.

revenueCurrency'USD' | 'EUR' nullable

A code.

budgetnumber nullable

A currency amount.

budgetCurrency'USD' | 'EUR' nullable

A code.

contactsTemplateIdstring nullable

An ID of the record of the Template type.

contactsTemplateNamestring nullable

A foreign record name.

leadsTemplateIdstring nullable

An ID of the record of the Template type.

leadsTemplateNamestring nullable

A foreign record name.

accountsTemplateIdstring nullable

An ID of the record of the Template type.

accountsTemplateNamestring nullable

A foreign record name.

usersTemplateIdstring nullable

An ID of the record of the Template type.

usersTemplateNamestring nullable

A foreign record name.

mailMergeOnlyWithAddressboolean
revenueConvertednumber nullable

A currency amount converted to the default currency.

budgetConvertednumber nullable

A currency amount converted to the default currency.

Example response

{
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56"
}