Get | Kard API

{
  "data": {
    "type": "placement",
    "attributes": {
      "name": "name",
      "organizationId": "organizationId",
      "availableSlots": 1,
      "displayName": "displayName",
      "contentStrategyId": "contentStrategyId"
    },
    "id": "id",
    "relationships": {
      "contentStrategy": {
        "data": {
          "type": "type",
          "id": "id"
        }
      }
    }
  },
  "included": [
    {
      "type": "contentStrategy",
      "attributes": {
        "name": "name",
        "organizationId": "organizationId",
        "filters": {
          "categories": [
            "categories",
            "categories"
          ],
          "categoryExclusions": [
            "categoryExclusions",
            "categoryExclusions"
          ],
          "merchantExclusions": [
            "merchantExclusions",
            "merchantExclusions"
          ],
          "offerFeatures": [
            "INTERACTIVE",
            "INTERACTIVE"
          ]
        },
        "categories": [
          "Arts & Entertainment",
          "Arts & Entertainment"
        ],
        "categoryExclusions": [
          "Arts & Entertainment",
          "Arts & Entertainment"
        ],
        "merchantExclusions": [
          "merchantExclusions",
          "merchantExclusions"
        ],
        "sort": "NEWLY_LIVE"
      },
      "id": "id"
    },
    {
      "type": "contentStrategy",
      "attributes": {
        "name": "name",
        "organizationId": "organizationId",
        "filters": {
          "categories": [
            "categories",
            "categories"
          ],
          "categoryExclusions": [
            "categoryExclusions",
            "categoryExclusions"
          ],
          "merchantExclusions": [
            "merchantExclusions",
            "merchantExclusions"
          ],
          "offerFeatures": [
            "INTERACTIVE",
            "INTERACTIVE"
          ]
        },
        "categories": [
          "Arts & Entertainment",
          "Arts & Entertainment"
        ],
        "categoryExclusions": [
          "Arts & Entertainment",
          "Arts & Entertainment"
        ],
        "merchantExclusions": [
          "merchantExclusions",
          "merchantExclusions"
        ],
        "sort": "NEWLY_LIVE"
      },
      "id": "id"
    }
  ]
}

Retrieve a specific placement

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

Unique identifier of the organization

placementIdstringRequired

Unique identifier of the placement (UUID v7)

Query parameters

includestringOptional

CSV list of related resources to embed in the included array. Supported paths: contentStrategy (the direct content strategy of a non-batch placement), slots (the slot resources of a batch-activation or group placement), slots.placement (and the placement each slot references), and slots.placement.contentStrategy (and the content strategy of each referenced placement). Dotted paths implicitly include all intermediate resources.

Response

Placement resource (optionally with embedded related resources)

dataobject

Placement resource

includedlist of objectsOptional

Related resources requested via the include query parameter. Each entry is keyed by its type discriminant (contentStrategy, batchActivationSlot, placement, placementPushNotification, placementEmail).

Errors

401

Unauthorized Error

403

Forbidden Error

404

Does Not Exist Error

500

Internal Server Error