--- title: "Get" method: GET path: "/v2/issuers/{organizationId}/placements/{placementId}" tags: ["Organizations > Placements"] --- # Get `GET /v2/issuers/{organizationId}/placements/{placementId}` ## Request - Base URL: `https://rewards-api.getkard.com` - URL: `https://rewards-api.getkard.com/v2/issuers/{organizationId}/placements/{placementId}` - Auth: HTTP bearer Retrieve a specific placement ## Path parameters - `organizationId` string, required - `placementId` string, required ## Query parameters - `include` string ## Response `200` Placement resource (optionally with embedded related resources) - OrganizationsPlacementsPlacementResource: Single placement document, optionally with embedded related resources - `data` union, required: Discriminated union for placement resources keyed on type - object - `type` 'placement', required: Discriminator value: placement - `id` string, required: Unique identifier of the placement (UUID v7) - `attributes` OrganizationsPlacementsPlacementAttributes, required: Attributes for a standard placement - `name` string, required: Name of the placement - `displayName` string: Cardholder-facing title for the section, if one was set. When absent, clients fall back to their own default label. - `organizationId` string, required: ID of the organization this placement belongs to - `availableSlots` integer, required: Number of available slots - `contentStrategyId` string: ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility. - `relationships` OrganizationsPlacementsPlacementRelationships: Relationship block for non-batch placements. Mirrors the `contentStrategyId` attribute so JSON:API clients can walk the graph. - `contentStrategy` OrganizationsPlacementsToOneRelationship: A JSON:API to-one relationship payload. - `data` OrganizationsPlacementsResourceIdentifier: A reference to another resource by type and id. - `type` string, required: Discriminant of the referenced resource (e.g. `contentStrategy`). - `id` string, required: Identifier of the referenced resource. - object - `type` 'placementPushNotification', required: Discriminator value: placementPushNotification - `id` string, required: Unique identifier of the placement (UUID v7) - `attributes` OrganizationsPlacementsPushNotificationPlacementAttributes, required: Attributes for a push-notification placement - `name` string, required: Name of the placement - `status` 'ACTIVE' | 'INACTIVE', required: Whether a scheduled placement's deliveries are paused. INACTIVE removes the placement's delivery schedule (push/email); ACTIVE re-creates it. Status has no effect on content serving. - `organizationId` string, required: ID of the organization this placement belongs to - `cadence` OrganizationsPlacementsCadence, required: Cadence schedule for push notification and email placements - `frequency` 'DAILY' | 'WEEKLY' | 'MONTHLY', required: How often a push notification or email placement delivers - `timeOfDay` string: Optional time of day in HH:mm format (24-hour, UTC) - `dayOfWeek` 'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT' | 'SUN': Day of the week (used when frequency is WEEKLY, or with weekOfMonth) - `dayOfMonth` integer: Day of the month to deliver, 1-31 (used when frequency is MONTHLY, defaults to 1). For 29-31, months without that day deliver on their last day. - `weekOfMonth` 'FIRST' | 'LAST': Which occurrence of dayOfWeek in the month to deliver on - `contentStrategyId` string: ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility. - `createdAt` string, date-time, required: When the placement was created - `relationships` OrganizationsPlacementsPlacementRelationships: Relationship block for non-batch placements. Mirrors the `contentStrategyId` attribute so JSON:API clients can walk the graph. - `contentStrategy` OrganizationsPlacementsToOneRelationship: A JSON:API to-one relationship payload. - `data` OrganizationsPlacementsResourceIdentifier: A reference to another resource by type and id. - `type` string, required: Discriminant of the referenced resource (e.g. `contentStrategy`). - `id` string, required: Identifier of the referenced resource. - object - `type` 'placementEmail', required: Discriminator value: placementEmail - `id` string, required: Unique identifier of the placement (UUID v7) - `attributes` OrganizationsPlacementsEmailPlacementAttributes, required: Attributes for an email placement - `name` string, required: Name of the placement - `status` 'ACTIVE' | 'INACTIVE', required: Whether a scheduled placement's deliveries are paused. INACTIVE removes the placement's delivery schedule (push/email); ACTIVE re-creates it. Status has no effect on content serving. - `organizationId` string, required: ID of the organization this placement belongs to - `availableSlots` integer, required: Number of available slots - `cadence` OrganizationsPlacementsCadence, required: Cadence schedule for push notification and email placements - `frequency` 'DAILY' | 'WEEKLY' | 'MONTHLY', required: How often a push notification or email placement delivers - `timeOfDay` string: Optional time of day in HH:mm format (24-hour, UTC) - `dayOfWeek` 'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT' | 'SUN': Day of the week (used when frequency is WEEKLY, or with weekOfMonth) - `dayOfMonth` integer: Day of the month to deliver, 1-31 (used when frequency is MONTHLY, defaults to 1). For 29-31, months without that day deliver on their last day. - `weekOfMonth` 'FIRST' | 'LAST': Which occurrence of dayOfWeek in the month to deliver on - `contentStrategyId` string: ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility. - `createdAt` string, date-time, required: When the placement was created - `relationships` OrganizationsPlacementsPlacementRelationships: Relationship block for non-batch placements. Mirrors the `contentStrategyId` attribute so JSON:API clients can walk the graph. - `contentStrategy` OrganizationsPlacementsToOneRelationship: A JSON:API to-one relationship payload. - `data` OrganizationsPlacementsResourceIdentifier: A reference to another resource by type and id. - `type` string, required: Discriminant of the referenced resource (e.g. `contentStrategy`). - `id` string, required: Identifier of the referenced resource. - object - `type` 'placementBatchActivation', required: Discriminator value: placementBatchActivation - `id` string, required: Unique identifier of the placement (UUID v7) - `attributes` OrganizationsPlacementsBatchActivationPlacementAttributes, required: Attributes for a batch-activation placement. Slot detail is exposed via `relationships.slots` (resource identifiers) and the `batchActivationSlot` entries in `included`; request `?include=slots` (or a deeper path) to get the slot details. - `name` string, required: Name of the placement - `organizationId` string, required: ID of the organization this placement belongs to - `refreshInterval` string, required: ISO-8601 duration that controls how often the activation cohort refreshes (e.g. "P7D" for weekly). - `relationships` OrganizationsPlacementsSlottedPlacementRelationships, required: Relationship block for a batch-activation or group placement. - `slots` OrganizationsPlacementsToManyRelationship, required: A JSON:API to-many relationship payload. - `data` OrganizationsPlacementsResourceIdentifier[], required: The linked resource identifiers. - `type` string, required: Discriminant of the referenced resource (e.g. `contentStrategy`). - `id` string, required: Identifier of the referenced resource. - object - `type` 'placementGroup', required: Discriminator value: placementGroup - `id` string, required: Unique identifier of the placement (UUID v7) - `attributes` OrganizationsPlacementsGroupPlacementAttributes, required: Attributes for a group placement. A group is configured like a batch-activation placement but has no refreshInterval. Slot detail is exposed via `relationships.slots` (resource identifiers) and the `batchActivationSlot` entries in `included`; request `?include=slots` (or a deeper path) to get the slot details. - `name` string, required: Name of the placement - `organizationId` string, required: ID of the organization this placement belongs to - `relationships` OrganizationsPlacementsSlottedPlacementRelationships, required: Relationship block for a batch-activation or group placement. - `slots` OrganizationsPlacementsToManyRelationship, required: A JSON:API to-many relationship payload. - `data` OrganizationsPlacementsResourceIdentifier[], required: The linked resource identifiers. - `type` string, required: Discriminant of the referenced resource (e.g. `contentStrategy`). - `id` string, required: Identifier of the referenced resource. - `included` OrganizationsPlacementsIncludedResource[]: Related resources requested via the `include` query parameter. Each entry is keyed by its `type` discriminant (`contentStrategy`, `batchActivationSlot`, `placement`, `placementPushNotification`, `placementEmail`). - union: Discriminated union of every resource type that can appear in the `included` array. The shape of each branch matches the corresponding primary-data resource (same attributes and relationships), keyed on the JSON:API `type` discriminant. - object - `type` 'contentStrategy', required: Discriminator value: contentStrategy - `id` string, required - `attributes` OrganizationsContentStrategiesContentStrategyAttributes, required: Attributes for a content strategy - `name` string, required: Name of the content strategy (unique within an organization) - `organizationId` string, required: ID of the organization this content strategy belongs to - `sort` 'NEWLY_LIVE' | 'EXPIRING_SOON' | 'HIGHEST_CASHBACK' | 'PERSONALIZED' | 'OFFERS_NEAR_YOU': Sort applied to the offers selected by a content strategy. A strategy may have at most one sort. The v1 starter set covers newly-live, expiring-soon, highest-cashback, personalized, and offers-near-you selections. - `filters` OrganizationsContentStrategiesContentStrategyFilters, required: Filters applied when selecting offers for a content strategy - `categories` string[]: Merchant categories to include - `categoryExclusions` string[]: Merchant categories to exclude - `merchants` string[]: Merchant IDs to include - `merchantExclusions` string[]: Merchant IDs to exclude - `offerFeatures` OrganizationsContentStrategiesOfferFeatures[]: Offer features to filter by - `categories` CommonsCategoryOption[], required: Merchant categories to include - `categoryExclusions` CommonsCategoryOption[], required: Merchant categories to exclude - `merchantExclusions` string[], required: Merchant IDs to exclude - object - `type` 'batchActivationSlot', required: Discriminator value: batchActivationSlot - `id` string, required - `attributes` OrganizationsPlacementsBatchActivationSlotAttributes, required: Attributes block for a `batchActivationSlot` resource. - `alias` string, required: Customer-defined alias for the slot, unique within the placement. - `shortDescription` string: Optional short description of the slot, limited to 50 characters. - `relationships` OrganizationsPlacementsBatchActivationSlotRelationships, required: Relationship block for a `batchActivationSlot` resource. - `placement` OrganizationsPlacementsToOneRelationship, required: A JSON:API to-one relationship payload. - `data` OrganizationsPlacementsResourceIdentifier: A reference to another resource by type and id. - … - object - `type` 'placement', required: Discriminator value: placement - `id` string, required: Unique identifier of the placement (UUID v7) - `attributes` OrganizationsPlacementsPlacementAttributes, required: Attributes for a standard placement - `name` string, required: Name of the placement - `displayName` string: Cardholder-facing title for the section, if one was set. When absent, clients fall back to their own default label. - `organizationId` string, required: ID of the organization this placement belongs to - `availableSlots` integer, required: Number of available slots - `contentStrategyId` string: ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility. - `relationships` OrganizationsPlacementsPlacementRelationships: Relationship block for non-batch placements. Mirrors the `contentStrategyId` attribute so JSON:API clients can walk the graph. - `contentStrategy` OrganizationsPlacementsToOneRelationship: A JSON:API to-one relationship payload. - `data` OrganizationsPlacementsResourceIdentifier: A reference to another resource by type and id. - … - object - `type` 'placementPushNotification', required: Discriminator value: placementPushNotification - `id` string, required: Unique identifier of the placement (UUID v7) - `attributes` OrganizationsPlacementsPushNotificationPlacementAttributes, required: Attributes for a push-notification placement - `name` string, required: Name of the placement - `status` 'ACTIVE' | 'INACTIVE', required: Whether a scheduled placement's deliveries are paused. INACTIVE removes the placement's delivery schedule (push/email); ACTIVE re-creates it. Status has no effect on content serving. - `organizationId` string, required: ID of the organization this placement belongs to - `cadence` OrganizationsPlacementsCadence, required: Cadence schedule for push notification and email placements - `frequency` 'DAILY' | 'WEEKLY' | 'MONTHLY', required: How often a push notification or email placement delivers - `timeOfDay` string: Optional time of day in HH:mm format (24-hour, UTC) - `dayOfWeek` 'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT' | 'SUN': Day of the week (used when frequency is WEEKLY, or with weekOfMonth) - `dayOfMonth` integer: Day of the month to deliver, 1-31 (used when frequency is MONTHLY, defaults to 1). For 29-31, months without that day deliver on their last day. - `weekOfMonth` 'FIRST' | 'LAST': Which occurrence of dayOfWeek in the month to deliver on - `contentStrategyId` string: ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility. - `createdAt` string, date-time, required: When the placement was created - `relationships` OrganizationsPlacementsPlacementRelationships: Relationship block for non-batch placements. Mirrors the `contentStrategyId` attribute so JSON:API clients can walk the graph. - `contentStrategy` OrganizationsPlacementsToOneRelationship: A JSON:API to-one relationship payload. - `data` OrganizationsPlacementsResourceIdentifier: A reference to another resource by type and id. - … - object - `type` 'placementEmail', required: Discriminator value: placementEmail - `id` string, required: Unique identifier of the placement (UUID v7) - `attributes` OrganizationsPlacementsEmailPlacementAttributes, required: Attributes for an email placement - `name` string, required: Name of the placement - `status` 'ACTIVE' | 'INACTIVE', required: Whether a scheduled placement's deliveries are paused. INACTIVE removes the placement's delivery schedule (push/email); ACTIVE re-creates it. Status has no effect on content serving. - `organizationId` string, required: ID of the organization this placement belongs to - `availableSlots` integer, required: Number of available slots - `cadence` OrganizationsPlacementsCadence, required: Cadence schedule for push notification and email placements - `frequency` 'DAILY' | 'WEEKLY' | 'MONTHLY', required: How often a push notification or email placement delivers - `timeOfDay` string: Optional time of day in HH:mm format (24-hour, UTC) - `dayOfWeek` 'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT' | 'SUN': Day of the week (used when frequency is WEEKLY, or with weekOfMonth) - `dayOfMonth` integer: Day of the month to deliver, 1-31 (used when frequency is MONTHLY, defaults to 1). For 29-31, months without that day deliver on their last day. - `weekOfMonth` 'FIRST' | 'LAST': Which occurrence of dayOfWeek in the month to deliver on - `contentStrategyId` string: ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility. - `createdAt` string, date-time, required: When the placement was created - `relationships` OrganizationsPlacementsPlacementRelationships: Relationship block for non-batch placements. Mirrors the `contentStrategyId` attribute so JSON:API clients can walk the graph. - `contentStrategy` OrganizationsPlacementsToOneRelationship: A JSON:API to-one relationship payload. - `data` OrganizationsPlacementsResourceIdentifier: A reference to another resource by type and id. - … ## Other responses - `401`: Error response with status 401 - `403`: Error response with status 403 - `404`: Error response with status 404 - `429`: The issuer's traffic grew faster than its allowed rate, or the endpoint's own limit was reached. If the response includes a `Retry-After` header, wait that many seconds before retrying. See [Rate Limits](/2024-10-01/api/integration-guides/rate-limits). - `500`: Error response with status 500 ## Changes - **2026-10-22** `4e87fc8b018b`: 2 info - added the non-success response with the status `429` - added the optional property `included/items/oneOf[subschema #1]/attributes/filters/merchants` to the response with the `200` status - **2026-10-19** `a664c5d23771`: 2 breaking, 2 info - added `subschema #2, subschema #3` to the `data` response property `oneOf` list for the response status `200` - added `subschema #4, subschema #5` to the `included/items/` response property `oneOf` list for the response status `200` - removed `subschema #2, subschema #3` from the `data` response property `oneOf` list for the response status `200` - removed `subschema #4, subschema #5` from the `included/items/` response property `oneOf` list for the response status `200` [Operation history](https://skmtc.dev/getkard/apis/getkard-2/changes/v2/issuers/:organizationId/placements/:placementId/get.md) --- [API](https://skmtc.dev/getkard/apis/getkard-2.md) - [All operations](https://skmtc.dev/getkard/apis/getkard-2/llms.txt) - [OpenAPI document](https://skmtc.dev/getkard/apis/getkard-2/revisions/bd47764afa21?raw)