GET
/
v1
/
products
Get All User Products
curl --request GET \
  --url https://api.roastify.app/v1/products \
  --header 'x-api-key: <api-key>'
{
  "products": [
    {
      "id": "clyd67824rn3f78g0f8j9",
      "createdAt": "2024-02-19T17:09:28.925Z",
      "title": "12oz Coffee Box",
      "description": "<string>",
      "imageUrl": "https://storage.roastify.app/mockup-images/a045d749-8372-44a0-aga3-098688ab6ad2.jpeg",
      "productType": "CoffeeBox12oz",
      "images": [
        {
          "url": "https://storage.roastify.app/mockup-images/a045d749-8372-44a0-aga3-098688ab6ad2.jpeg"
        }
      ],
      "variants": [
        {
          "id": "clyd67824rn3f78g0f8j9",
          "title": "Whole Bean",
          "size": "12oz",
          "retailPrice": 1200,
          "sku": "COF-GND-12O-COL-BOX",
          "inStock": true,
          "stockQty": 999,
          "plan": "pro"
        }
      ]
    }
  ],
  "pageInfo": {
    "endCursor": "<string>",
    "hasNextPage": true
  }
}

Authorizations

​
x-api-key
string
header
required

The API key to authenticate requests provided by Roastify. A Base or Pro plan is required to use the API.

Query Parameters

​
cursor
string

The cursor to start from. This is the productId of the last product in the previous page. This can also be found in the endCursor property of the previous page's response.

Example:

"clyd67824rn3f78g0f8j9"

​
pageSize
string

The number of results to return. Defaults to 20 and maximum is 100

Example:

"10"

Response

200
application/json

Returns all products in your Roastify Merchant account (paginated)

The response is of type object.