Get Placement Content

{
  "data": [
    {
      "type": "standardOffer",
      "id": "5e27318c9b346f00087fbb5c",
      "attributes": {
        "name": "World's Greatest Chicken",
        "terms": "Offer valid at US locations only.",
        "purchaseChannel": [
          "INSTORE"
        ],
        "userReward": {
          "type": "PERCENT",
          "value": 5.7
        },
        "startDate": "2024-11-17T05:00:00Z",
        "expirationDate": "2025-03-17T05:00:00Z",
        "isTargeted": true,
        "assets": [
          {
            "type": "IMG_VIEW",
            "url": "https://attribution.getkard.com/logos/wgc_logo.png?token=example",
            "alt": ""
          }
        ],
        "websiteUrl": "https://worldsgreatestchicken.test.com",
        "description": "Crispy, double-fried spicy chicken."
      },
      "relationships": {
        "category": {
          "data": [
            {
              "type": "category",
              "id": "65920081b524d126068de24a"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "type": "category",
      "id": "65920081b524d126068de24a",
      "attributes": {
        "name": "Food & Beverage"
      }
    }
  ],
  "links": {
    "self": "/v2/issuers/organization-123/users/user-123/placements/placement-homepage-banner/content",
    "prev": null,
    "next": null
  },
  "meta": {
    "placementName": "Homepage Banner",
    "availableCategories": [
      {
        "type": "category",
        "id": "65920081b524d126068de24a",
        "attributes": {
          "name": "Food & Beverage"
        }
      }
    ]
  }
}

Retrieve the content for a placement. The placement type is resolved server-side so callers no longer pick an endpoint by placement type. Returns a JSON:API document whose data resources are self-describing by type: a standard placement returns standardOffer resources (with links, optional included categories, and meta); a batch-activation or group placement returns placementBatch slot resources. Distinguish the two by each resource’s type. Email and push-notification placements are not servable through this endpoint and respond with a 400.
Required scopes: rewards:read

Retrieve the content for a placement. The placement type is resolved server-side so callers no longer pick an endpoint by placement type. Returns a JSON:API document whose `data` resources are self-describing by `type`: a standard placement returns `standardOffer` resources (with `links`, optional `included` categories, and `meta`); a batch-activation or group placement returns `placementBatch` slot resources. Distinguish the two by each resource's `type`. Email and push-notification placements are not servable through this endpoint and respond with a `400`.<br/> <b>Required scopes:</b> `rewards:read`

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

Your issuer organization ID, provided by Kard

userIdstringRequired

The ID of the user as defined on the issuers system

placementIdstringRequired

Query parameters

includestringOptional

CSV list of included resources in the response (e.g “categories”). Allowed value is categories. Only applies to standard placements (those returning standardOffer resources).

supportedComponentsenumOptional

UI component types to include in the response.

Response

This endpoint returns an object.

Offers Response Objectobject

Batches Response Objectobject

Errors

400

Invalid Request

401

Unauthorized Error

404

Does Not Exist Error

500

Internal Server Error