Retrieve all quotes for a subscriber

This tutorial demonstrates how to retrieve a subscriber with their quotes in a single API request by using the _embed parameter. By embedding the quotes, you can retrieve the subscriber information and associated quotes without making separate requests for each resource.

Prerequisites

Before you start this tutorial:

• Make sure you have access to the Quoteable Service API.
• Make sure you have a tool such as Postman or cURL installed to make API requests.
• Have the subscriber ID for the quotes that you want to retrieve.

Retrieve subscriber with associated quotes

To retrieve a subscriber with their associated quotes, send a GET request to the /subscribers/{id} endpoint with the _embed parameter set to quotes.

To do so, follow these steps:

1. Open your API testing tool, such as Postman.
2. Create a new request with the following details:
   • METHOD: GET
   • URL: http://localhost:3000/subscribers/{id}?_embed=quotes (replace {id} with the actual subscriber ID)

Send the request.

A successful request returns the 200 OK status code.

In the response, you see the subscriber object with an additional quotes array that contains all the associated quotes for that subscriber.

Example

Request:

curl "http://localhost:3000/subscribers/1?_embed=quotes"

Response body:

{
  "id": 1,
  "lastName": "Stark",
  "firstName": "Tony",
  "email": "t.stark@example.com",
  "mobile": "2125551212",
  "healthQuote": true,
  "loveQuote": false,
  "helpPplQuote": true,
  "deliverTo": 1,
  "frequency": 3,
  "quotes": [
    {
      "subscriberId": 1,
      "id": 3,
      "healthQuoteText": "Good health is not something we can buy. However, it can be an extremely valuable savings account. - Anne Wilson Schaef",
      "loveQuoteText": "",
      "helpPplQuoteText": "At the end, it's not about what you have or even what you've accomplished. It's about who you've lifted up, who you've made better. It's about what you've given back. - Denzel Washington",
      "customQuote": false,
      "customQuoteText": "",
      "shareQuote": true,
      "shareQuoteContact": "pepper.pots@stark.com"
    }
  ]
}

What’s next?

After completing this tutorial, you can explore other endpoints and parameters provided by the Quoteable Service API to retrieve and manipulate data according to your application’s requirements.