users > Rewards

Get Placement Content

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

get/v2/issuers/{organizationId}/users/{userId}/placements/{placementId}/content

Request

  • Base URL: https://rewards-api.getkard.com
  • URL: https://rewards-api.getkard.com/v2/issuers/{organizationId}/users/{userId}/placements/{placementId}/content
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

Your issuer organization ID, provided by Kard

userIdstring required

The ID of the user as defined on the issuers system

placementIdstring required

Query parameters

includestring

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

supportedComponents'shortDescription' | 'longDescription' | 'baseReward' | 'boostedReward' | 'cta' | 'tags' | 'detailTags' | 'logoFlare' | 'progressBar'

Available UI component types for offers

UI component types to include in the response.

Response

Response with status 200

OR

Changes

No recorded changes to this operation across all 1 revision of this API.