GEgetkard
Organizations > Placements

List

Changed on

List placements belonging to the authenticated organization

get/v2/issuers/{organizationId}/placements

Request

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

Path parameters

organizationIdstring required

Unique identifier of the organization

Query parameters

filter[type]'placement' | 'placementPushNotification' | 'placementEmail' | 'placementBatchActivation' | 'placementGroup'

Placement type discriminator used as a list filter

Filter by placement type (placement, placementPushNotification, placementEmail, placementBatchActivation, or placementGroup)

filter[name]string

Filter by exact placement name (unique within an organization per type)

filter[contentStrategyId]string

Filter by the ID of the content strategy linked to the placement

includestring

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.

page[after]string

Cursor value for the next page of results

page[size]integer

Maximum number of records to return [1 - 200] (default = 200)

Response

Paginated list of placements

Changes

  • 4e87fc8b018bRevision changes
    • info

      added the non-success response with the status

    • info

      added the optional property ///// to the response with the status

  • a664c5d23771Revision changes
    • breaking

      added subschema #2 subschema #3 to the / response property oneOf list for the response status

    • breaking

      added subschema #4 subschema #5 to the / response property oneOf list for the response status

    • info

      removed subschema #2 subschema #3 from the / response property oneOf list for the response status

    • info

      removed subschema #4 subschema #5 from the / response property oneOf list for the response status