---
title: Retrieve a product list.
slug: docs/demo/retrieve-a-product-list
description: Learn how to make a GET request to a specific API endpoint using the curl command. This document provides a code example along with headers for accepting and sending JSON data. Enhance your API knowledge and optimize your development process with this hel
docTags: 
createdAt: 2022-03-21T20:12:45.000Z
---

{
  "id": "Fs89kOqinuYLPAb6nTl_U",
  "data": {
    "url": "https://api.fictive.com/REST/api/product-lists/{productListReference}",
    "name": "Retrieve a product list.",
    "method": "GET",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "productListReference",
          "type": "string",
          "description": ""
        }
      ],
      "queryParameters": [],
      "headerParameters": [
        {
          "kind": "optional",
          "name": "X-TokenId",
          "type": "string",
          "description": "The eSuite Token Id"
        },
        {
          "kind": "optional",
          "name": "X-SessionId",
          "type": "string",
          "description": "The eSuite Session Id"
        },
        {
          "kind": "required",
          "name": "X-Version",
          "type": "string",
          "description": "The eSuite Version"
        },
        {
          "kind": "optional",
          "name": "Origin",
          "type": "string",
          "description": "The eSuite Origin"
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": []
    },
    "responses": [
      {
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "schema": [
              {
                "kind": "optional",
                "name": "productListReference",
                "type": "string",
                "example": "",
                "description": "Product list reference."
              },
              {
                "kind": "optional",
                "name": "name",
                "type": "string",
                "example": "",
                "description": "product list name."
              },
              {
                "kind": "optional",
                "name": "associatedProducts",
                "type": "array",
                "example": [],
                "itemType": "string",
                "customType": "string[]",
                "description": "Associated products with the product list.",
                "itemExample": ""
              },
              {
                "kind": "optional",
                "name": "createdDate",
                "type": "string<date-time>",
                "example": "2021-09-21T05:33:22.9636152",
                "description": "Created date."
              },
              {
                "kind": "optional",
                "name": "lastUpdatedDate",
                "type": "string<date-time>",
                "example": "2021-09-21T05:33:22.9636152",
                "description": "Last updated date."
              }
            ],
            "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.ProductListResponse",
            "customType": "FictiveGlobal.Api.Rest.Dtos.v1.ProductListResponse",
            "isExpanded": true,
            "description": "Product list response wrapper."
          }
        ],
        "isExpanded": true,
        "statusCode": "200",
        "description": "OK.",
        "jsonExample": "{\n  \"productListReference\": \"001PLTRFD456544FD\",\n  \"name\": \"A list\",\n  \"associatedProducts\": [\n    \"0010BBLEC8GZAZA853\",\n    \"0010BZURPNZ3LJEM22\"\n  ],\n  \"createdDate\": \"2021-09-21T05:33:23.1042427\",\n  \"lastUpdatedDate\": \"2021-09-21T05:33:23.1042427\"\n}"
      },
      {
        "isExpanded": true,
        "statusCode": "400",
        "description": "Request is invalid.",
        "jsonExample": ""
      },
      {
        "isExpanded": true,
        "statusCode": "401",
        "description": "Not Authorized.",
        "jsonExample": ""
      },
      {
        "isExpanded": true,
        "statusCode": "404",
        "description": "Product list cannot be found.",
        "jsonExample": ""
      },
      {
        "isExpanded": true,
        "statusCode": "500",
        "description": "Internal Server Error.",
        "jsonExample": ""
      }
    ],
    "contentType": "application/json",
    "description": "This endpoint will allow you to retrieve a specific product list from the eSuite platform.",
    "examples": {
      "languages": [
        {
          "id": "D4VqQ2qU2CcqJTwFArT5Z",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.fictive.com/REST/api/product-lists/{productListReference} \\\n     --header 'accept: application/json' \\\n     --header 'x-version: string'"
        },
        {
          "id": "oXPW930o8_5WrVqWqQWSS",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-version\", \"string\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.fictive.com/REST/api/product-lists/{productListReference}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "gi4xzde7_NZyz85oqmq5s",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.fictive.com/REST/api/product-lists/{productListReference}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-version\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "B1f431Bs6WHBpTmzGJy0K",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.fictive.com/REST/api/product-lists/{productListReference}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json',\n   'x-version': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "D4VqQ2qU2CcqJTwFArT5Z"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "{\n  \"productListReference\": \"001PLTRFD456544FD\",\n  \"name\": \"A list\",\n  \"associatedProducts\": [\n    \"0010BBLEC8GZAZA853\",\n    \"0010BZURPNZ3LJEM22\"\n  ],\n  \"createdDate\": \"2021-09-21T05:33:23.1042427\",\n  \"lastUpdatedDate\": \"2021-09-21T05:33:23.1042427\"\n}"
        },
        {
          "id": "response-1-400",
          "language": "400",
          "code": "// Request is invalid.\n"
        },
        {
          "id": "response-2-401",
          "language": "401",
          "code": "// Not Authorized.\n"
        },
        {
          "id": "response-3-404",
          "language": "404",
          "code": "// Product list cannot be found.\n"
        },
        {
          "id": "response-4-500",
          "language": "500",
          "code": "// Internal Server Error.\n"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "type": "api-oas-v2",
  "children": [
    {
      "text": ""
    }
  ]
}