Skip to main content
GET
/
v1
/
cards
Retrieve cards
curl --request GET \
  --url https://api.ongoody.com/v1/cards \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "9f6a0a5e-bbd5-4bb6-bd6d-c6eaab586522",
      "image": {
        "url": "https://assets.ongoody.com/cards/222.png?format=png",
        "width": 800,
        "height": 1130
      },
      "image_thumb": {
        "url": "https://assets.ongoody.com/cards/222.png?width=200&format=png",
        "width": 200,
        "height": 283
      },
      "occasions": [
        "Congratulations",
        "Onboarding"
      ]
    },
    {
      "id": "addda4f1-f501-4dfe-9b1d-fa53c8814c85",
      "image": {
        "url": "https://assets.ongoody.com/cards/111.png?format=png",
        "width": 800,
        "height": 1130
      },
      "image_thumb": {
        "url": "https://assets.ongoody.com/cards/111.png?width=200&format=png",
        "width": 200,
        "height": 283
      },
      "occasions": []
    }
  ],
  "list_meta": {
    "total_count": 2
  }
}

Authorizations

​
Authorization
string
header
required

Your Goody API key.

Query Parameters

​
page
integer
default:1

Page for pagination, starting at 1

Required range: x >= 1
​
per_page
integer
default:20

Items per page for pagination

Required range: 1 <= x <= 100

Response

Cards retrieved

​
data
object[]
​
list_meta
object