Get Cards
/v1/cardsorg.permission.apps.readThe API key or user must hold at least one of them. Legacy roles still work; prefer the others for new keys.
Fetches all installed cards for an organization.
Note: Installed cards are the cards that will be displayed for a particular org using the app. They can be displayed on the customer, company, conversation, or kobject contexts.
Cards
A card is a web page you host that Kustomer loads in an iframe in the agent desktop next to a customer, conversation, company or custom object. Cards are the older way to embed your own UI; new integrations should use a KView with a DynamicCard instead.
A card pairs a url with the record types it should appear on. When an agent opens a record of one of those types, Kustomer loads the page so it can show related information from your system. Cards have two stages. First a card is made available, either by an app that includes it or with POST /v1/cards/available. Then it is installed into one or more contexts, which creates the installed card that agents see and that GET /v1/cards lists.
The cards section of an app definition is deprecated. For new work, use a KView that renders your page with DynamicCard, which embeds it with the Cards SDK, commands and theming documented there. These endpoints remain for managing existing cards.
Fields
| Field | Meaning |
|---|---|
name |
Identifier for the card, up to 128 characters of letters, digits, -, _ and . |
description |
What the card shows, up to 4,096 characters |
url |
The page Kustomer loads |
contexts |
Where the card appears. At least one, with no duplicates. |
app |
Optional, when creating. The app the card belongs to. |
Contexts
A context is a record type:
| Context | Card appears on |
|---|---|
customer |
Customer timelines |
conversation |
Conversations |
company |
Companies |
kobject.<klass> |
Custom objects of that Klass, such as kobject.order |
GET /v1/cards accepts a context filter to list only the cards installed for one record type.
Which endpoint to use
| To | Call |
|---|---|
| Make a new card available to install | POST /v1/cards/available |
| Install an available card into one or more contexts | POST /v1/cards/available/{id}/install |
| List installed cards, optionally for one context | GET /v1/cards |
| Read one installed card | GET /v1/cards/{id} |
| Change where an installed card appears | PUT /v1/cards/{id} |
| Remove an installed card | DELETE /v1/cards/{id} |
PUT /v1/cards/{id} only accepts contexts, and the list you send replaces the current one. To change a card's url or name, create and install a new card, then delete the old one. Reading cards needs an apps read role; creating, installing, updating and deleting need an apps write role, which admins have.
Query parameters
Page number to return.
1Number of records to return per page.
100Filter cards by installation context. Common values include customer, conversation, company, and custom object contexts such as kobject.order.
"conversation"Responses
OK