---
title: "Search engagement ring settings"
method: GET
path: "/api/v1/engagement-rings"
tags: ["Catalog"]
---

# Search engagement ring settings

`GET /api/v1/engagement-rings`

## Request

- Base URL: `https://www.adadiamonds.com`
- URL: `https://www.adadiamonds.com/api/v1/engagement-rings`
- Auth: one of:
  - none
  - API key in header `X-Ada-Api-Key`
  - OAuth 2 (authorization code, authorization URL `https://www.adadiamonds.com/oauth/authorize`, token URL `https://www.adadiamonds.com/api/oauth/token`; client credentials, token URL `https://www.adadiamonds.com/api/oauth/token`, scopes: `catalog:read`)

Returns a page of engagement ring settings filtered by the center stone shape they accommodate, style, type, and setting price. `priceFrom` is the setting alone and excludes the center diamond; pair a result with a stone from `listDiamonds` and add the two prices to quote a complete ring. Every setting is made to order in platinum or 14k/18k gold.

## Query parameters

- `shape` string
- `style` string
- `type` string
- `min_price` number
- `max_price` number
- `q` string
- `limit` integer
- `offset` integer

## Response `200`

A page of settings.

- EngagementRingList
  - `object` 'list', required
  - `currency` 'USD', required
  - `price_note` string
  - `data` EngagementRing[], required
    - `object` 'engagement_ring'
    - `currency` 'USD'
    - `price_note` string
    - `sku` string, required
    - `title` string, required
    - `url` string, uri, required
    - `shapes` string[], required
    - `style` string, nullable
    - `type` string, nullable
    - `priceFrom` number, nullable, required: USD. Setting only; excludes the center diamond.
    - `platinumUpcharge` number, nullable: USD added for platinum.
    - `twoToneUpcharge` number, nullable: USD added for a two-tone setting.
    - `images` ProductImage[], required
      - `metal` string, required
      - `view` 'primary' | 'alternate', required
      - `url` string, uri, required
      - `alt` string, nullable
  - `pagination` Pagination, required
    - `total` integer, required: Matches before pagination.
    - `limit` integer, required
    - `offset` integer, required
    - `has_more` boolean, required: Whether `offset + limit` would return more.

## Other responses

- `429`: Over the rate limit. Wait `Retry-After` seconds; a credential raises the limit.
- `502`: A catalog or content feed is temporarily unavailable. Retry in a few seconds.

---

[API](https://skmtc.dev/adadiamonds/apis/ada-diamonds-agent-api.md) · [All operations](https://skmtc.dev/adadiamonds/apis/ada-diamonds-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/adadiamonds/apis/ada-diamonds-agent-api/revisions/2b2ed3201815?raw)