Skip to content

Introduction

The Desire Company API is a small, read-only REST API for pulling your partner account's product content into your own storefront and product detail pages.

Base URL

https://api.prod.thedesirecompany.com/api/v1/public

Every endpoint on this page is relative to that base URL.

Authentication

All endpoints require an API key. Send it in either header:

Authorization: Bearer dk_live_your_key_here

or

X-API-Key: dk_live_your_key_here

Keys are scoped to your partner account — you only ever receive your own products. See Authentication for the full details.

Rate limits

Each API key is limited to 100 requests per minute. Responses include standard RateLimit-* headers. When you exceed the limit you receive 429 rate_limit_exceeded with a Retry-After header telling you how many seconds to wait.

Responses

Successful responses return HTTP 200 with a top-level data object:

json
{ "data": { "...": "..." } }

Errors return the appropriate HTTP status with a consistent envelope:

json
{ "error": "error_code", "message": "Human-readable explanation." }

The error field is a stable, machine-readable code you can branch on. See Errors for the full list.

Endpoints

MethodPathDescription
GET/sku/:skuGet a product's content + video JSON-LD by your SKU
GET/products/:idGet a product's content + video JSON-LD by its Desire Company ID

Conventions

  • All requests and responses are JSON over HTTPS.
  • The API is read-only — there are no write operations on the public surface.
  • The current version is v1, reflected in the /api/v1/public path prefix.

The Desire Company — Enterprise API