Get a Campaign

Returns a single campaign based on the ID supplied

GET /affiliate/campaigns/{id}

cURL

cURL

curl --request GET \
  --url https://api-beta.lomadee.com.br/affiliate/campaigns/{id} \
  --header 'x-api-key: <api-key>'

200

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "period": {
      "startAt": "<string>",
      "endAt": "<string>"
    },
    "type": "<string>",
    "offerType": "Spreadsheet",
    "categories": [
      "<string>"
    ],
    "description": "<string>",
    "code": "<string>",
    "url": "<string>",
    "organizationId": "<string>",
    "isHighlight": true,
    "status": "onTime",
    "createdAt": "<string>",
    "channels": [
      {
        "id": "<string>",
        "name": "<string>",
        "availableChannel": {
          "id": "<string>",
          "name": "<string>"
        },
        "shortUrls": [
          "<string>"
        ],
        "message": "<string>"
      }
    ],
    "mediaKit": {
      "banners": [
        "<string>"
      ],
      "emailMarketing": "<unknown>"
    }
  },
  "meta": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

Get a Campaign

Returns a single campaign based on the ID supplied.

HTTP Request

Campaign Status Field

The campaign response includes a status field that is automatically calculated based on the period:

Status	Description
onTime	Active campaign within period
expired	Campaign expired (period.endAt has passed)
scheduled	Campaign scheduled (period.startAt not arrived)

Authorizations

x-api-key · string · header · required

Path Parameters

id · string · required

ID of campaign to return

Response

200

application/json

Campaign response

data · object

Show child attributes

meta · object

Show child attributes