List | Kard API

curl https://rewards-api.getkard.com/v2/issuers/organizationId/placements \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "type": "placementMainPage",
      "attributes": {
        "name": "name",
        "organizationId": "organizationId",
        "availableSlots": 1,
        "createdAt": "2024-01-15T09:30:00Z",
        "lastModified": "2024-01-15T09:30:00Z"
      },
      "id": "id"
    },
    {
      "type": "placementMainPage",
      "attributes": {
        "name": "name",
        "organizationId": "organizationId",
        "availableSlots": 1,
        "createdAt": "2024-01-15T09:30:00Z",
        "lastModified": "2024-01-15T09:30:00Z"
      },
      "id": "id"
    }
  ],
  "links": {
    "self": "self",
    "prev": "prev",
    "next": "next"
  },
  "meta": {
    "pageSize": 1,
    "hasNextPage": true
  }
}

List placements belonging to the authenticated organization

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

Unique identifier of the organization

Query parameters

filter[type]enumOptional

Filter by placement type (placementMainPage or placementPushNotification)

Allowed values:

filter[name]stringOptional

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

page[after]stringOptional

Cursor value for the next page of results

page[size]integerOptional

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

Response

Paginated list of placements

datalist of objects

Array of placement resources

linksobject

Errors

400

Invalid Request

401

Unauthorized Error

403

Forbidden Error

404

Does Not Exist Error

500

Internal Server Error