v1

latestOpenAPI 3.0.32026-07-173196215.4 KB

campaigns

Get a campaign

Get one campaign by campaignId.

get/v1/campaigns/{campaignId}

Path parameters

campaignIdinteger required

Campaign id

Response

successful operation

idinteger

namestring

keystring

descriptionstring

reductioninteger

customDataobject

start_atstring

end_atstring

Example response

{
  "id": 20201,
  "name": "Summer_Campaign",
  "description": "10% discount for all summer products",
  "reduction": 10,
  "start_at": "2021-04-13T08:45:00+00:00",
  "end_at": "2021-05-13T08:45:00+00:00"
}