---
title: Retrieve a configured schedule
slug: docs/demo/retrieve-a-configured-schedule
description: Learn how to use curl to send a GET request to a simulated API and retrieve JSON-formatted product schedules. This code example will guide you through the process and help you understand the necessary headers and parameters to achieve the desired response
createdAt: 2022-03-21T20:12:45.000Z
---

{
  "id": "AHbK4lVUaeOow4AyA-DxF",
  "data": {
    "url": "https://api.fictive.com/REST/api/products/{productReference}/schedules",
    "name": "Retrieve a configured schedule",
    "method": "GET",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "productReference",
          "type": "string"
        }
      ],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "pastDates",
          "type": "boolean"
        }
      ],
      "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": "array",
            "schema": [
              {
                "kind": "optional",
                "name": "scheduleReference",
                "type": "string",
                "example": ""
              },
              {
                "kind": "optional",
                "name": "entitlementFormat",
                "type": "string",
                "example": ""
              },
              {
                "kind": "optional",
                "name": "friendlyName",
                "type": "string",
                "example": ""
              },
              {
                "kind": "optional",
                "name": "scheduleType",
                "type": "string",
                "example": ""
              },
              {
                "kind": "optional",
                "name": "dailySchedule",
                "type": "object",
                "schema": [
                  {
                    "kind": "optional",
                    "name": "issuingTime",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "monday",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "tuesday",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "wednesday",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "thursday",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "friday",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "saturday",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "sunday",
                    "type": "boolean",
                    "example": ""
                  }
                ],
                "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.DailySchedule",
                "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.DailySchedule",
                "description": "DTO representing a publication calendar daily schedule"
              },
              {
                "kind": "optional",
                "name": "monthlySchedule",
                "type": "object",
                "schema": [
                  {
                    "kind": "optional",
                    "name": "issuingDay",
                    "type": "integer<int32>",
                    "example": 0
                  },
                  {
                    "kind": "optional",
                    "name": "issuingTime",
                    "type": "string",
                    "example": ""
                  }
                ],
                "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.MonthlySchedule",
                "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.MonthlySchedule",
                "description": "DTO representing a publication calendar monthly schedule"
              },
              {
                "kind": "optional",
                "name": "annualSchedule",
                "type": "object",
                "schema": [
                  {
                    "kind": "optional",
                    "name": "issuingMonth",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "issuingDay",
                    "type": "integer<int32>",
                    "example": 0
                  },
                  {
                    "kind": "optional",
                    "name": "issuingTime",
                    "type": "string",
                    "example": ""
                  }
                ],
                "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.AnnualSchedule",
                "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.AnnualSchedule",
                "description": "DTO representing a publication calendar annual schedule"
              },
              {
                "kind": "optional",
                "name": "customSchedule",
                "type": "object",
                "schema": [
                  {
                    "kind": "optional",
                    "name": "startDate",
                    "type": "string<date-time>",
                    "example": "2021-09-21T05:33:24.1511371"
                  },
                  {
                    "kind": "optional",
                    "name": "issuingFrequency",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "issuingUnit",
                    "type": "integer<int32>",
                    "example": 0
                  }
                ],
                "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.CustomSchedule",
                "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.CustomSchedule",
                "description": "DTO representing a publication calendar custom schedule"
              },
              {
                "kind": "optional",
                "name": "irregularSchedule",
                "type": "array",
                "example": [],
                "itemType": "string",
                "customType": "string[]",
                "itemExample": ""
              },
              {
                "kind": "optional",
                "name": "nonIssuingDates",
                "type": "array",
                "example": [],
                "itemType": "string",
                "customType": "string[]",
                "itemExample": ""
              },
              {
                "kind": "optional",
                "name": "issuePriorToStart",
                "type": "boolean",
                "example": ""
              },
              {
                "kind": "optional",
                "name": "entitlementEnds",
                "type": "object",
                "schema": [
                  {
                    "kind": "optional",
                    "name": "endsNever",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "endsAfterTimeUnit",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "endsAfterNumberOfTimeUnits",
                    "type": "integer<int32>",
                    "example": 0
                  },
                  {
                    "kind": "optional",
                    "name": "endsDateTime",
                    "type": "string<date-time>",
                    "example": ""
                  }
                ],
                "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.EntitlementEnd",
                "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.EntitlementEnd",
                "description": "DTO representing a Entitlement End"
              }
            ],
            "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.PublicationCalendarResponse",
            "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.PublicationCalendarResponse[]",
            "isExpanded": true,
            "description": "DTO representing a publication calendar response"
          }
        ],
        "isExpanded": true,
        "statusCode": "200",
        "description": "Ok",
        "jsonExample": "[\n  {\n    \"scheduleReference\": \"001CA72IBXWWAV51M2\",\n    \"entitlementFormat\": \"EntitlementFormat1\",\n    \"friendlyName\": \"Example name 1\",\n    \"scheduleType\": \"Daily\",\n    \"dailySchedule\": {\n      \"issuingTime\": \"05:33\",\n      \"monday\": true,\n      \"tuesday\": true,\n      \"wednesday\": true,\n      \"thursday\": true,\n      \"friday\": true,\n      \"saturday\": false,\n      \"sunday\": false\n    },\n    \"nonIssuingDates\": [\n      \"2021-09-21\",\n      \"2021-11-21\"\n    ],\n    \"issuePriorToStart\": false,\n    \"entitlementEnds\": {\n      \"endsNever\": false,\n      \"endsAfterTimeUnit\": \"days\",\n      \"endsAfterNumberOfTimeUnits\": 2\n    }\n  },\n  {\n    \"scheduleReference\": \"001CAPXW95X1T69HK2\",\n    \"entitlementFormat\": \"EntitlementFormat2\",\n    \"friendlyName\": \"Example name 2\",\n    \"scheduleType\": \"Monthly\",\n    \"monthlySchedule\": {\n      \"issuingDay\": 21,\n      \"issuingTime\": \"05:33\"\n    },\n    \"nonIssuingDates\": [],\n    \"issuePriorToStart\": false,\n    \"entitlementEnds\": {\n      \"endsNever\": true\n    }\n  },\n  {\n    \"scheduleReference\": \"001CAS4VA3ZP3HYOU2\",\n    \"entitlementFormat\": \"EntitlementFormat3\",\n    \"friendlyName\": \"Example name 3\",\n    \"scheduleType\": \"Annual\",\n    \"annualSchedule\": {\n      \"issuingMonth\": \"September\",\n      \"issuingDay\": 21,\n      \"issuingTime\": \"05:33\"\n    },\n    \"nonIssuingDates\": [],\n    \"issuePriorToStart\": false,\n    \"entitlementEnds\": {\n      \"endsNever\": false,\n      \"endsDateTime\": \"2021-09-21T05:33:24.2917612\"\n    }\n  }\n]"
      },
      {
        "schema": [
          {
            "kind": "optional",
            "type": "array",
            "schema": [
              {
                "kind": "optional",
                "name": "scheduleReference",
                "type": "string",
                "example": ""
              },
              {
                "kind": "optional",
                "name": "entitlementFormat",
                "type": "string",
                "example": ""
              },
              {
                "kind": "optional",
                "name": "friendlyName",
                "type": "string",
                "example": ""
              },
              {
                "kind": "optional",
                "name": "scheduleType",
                "type": "string",
                "example": ""
              },
              {
                "kind": "optional",
                "name": "dailySchedule",
                "type": "object",
                "schema": [
                  {
                    "kind": "optional",
                    "name": "issuingTime",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "monday",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "tuesday",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "wednesday",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "thursday",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "friday",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "saturday",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "sunday",
                    "type": "boolean",
                    "example": ""
                  }
                ],
                "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.DailySchedule",
                "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.DailySchedule",
                "description": "DTO representing a publication calendar daily schedule"
              },
              {
                "kind": "optional",
                "name": "monthlySchedule",
                "type": "object",
                "schema": [
                  {
                    "kind": "optional",
                    "name": "issuingDay",
                    "type": "integer<int32>",
                    "example": 0
                  },
                  {
                    "kind": "optional",
                    "name": "issuingTime",
                    "type": "string",
                    "example": ""
                  }
                ],
                "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.MonthlySchedule",
                "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.MonthlySchedule",
                "description": "DTO representing a publication calendar monthly schedule"
              },
              {
                "kind": "optional",
                "name": "annualSchedule",
                "type": "object",
                "schema": [
                  {
                    "kind": "optional",
                    "name": "issuingMonth",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "issuingDay",
                    "type": "integer<int32>",
                    "example": 0
                  },
                  {
                    "kind": "optional",
                    "name": "issuingTime",
                    "type": "string",
                    "example": ""
                  }
                ],
                "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.AnnualSchedule",
                "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.AnnualSchedule",
                "description": "DTO representing a publication calendar annual schedule"
              },
              {
                "kind": "optional",
                "name": "customSchedule",
                "type": "object",
                "schema": [
                  {
                    "kind": "optional",
                    "name": "startDate",
                    "type": "string<date-time>",
                    "example": "2021-09-21T05:33:24.1511371"
                  },
                  {
                    "kind": "optional",
                    "name": "issuingFrequency",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "issuingUnit",
                    "type": "integer<int32>",
                    "example": 0
                  }
                ],
                "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.CustomSchedule",
                "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.CustomSchedule",
                "description": "DTO representing a publication calendar custom schedule"
              },
              {
                "kind": "optional",
                "name": "irregularSchedule",
                "type": "array",
                "example": [],
                "itemType": "string",
                "customType": "string[]",
                "itemExample": ""
              },
              {
                "kind": "optional",
                "name": "nonIssuingDates",
                "type": "array",
                "example": [],
                "itemType": "string",
                "customType": "string[]",
                "itemExample": ""
              },
              {
                "kind": "optional",
                "name": "issuePriorToStart",
                "type": "boolean",
                "example": ""
              },
              {
                "kind": "optional",
                "name": "entitlementEnds",
                "type": "object",
                "schema": [
                  {
                    "kind": "optional",
                    "name": "endsNever",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "endsAfterTimeUnit",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "kind": "optional",
                    "name": "endsAfterNumberOfTimeUnits",
                    "type": "integer<int32>",
                    "example": 0
                  },
                  {
                    "kind": "optional",
                    "name": "endsDateTime",
                    "type": "string<date-time>",
                    "example": ""
                  }
                ],
                "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.EntitlementEnd",
                "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.EntitlementEnd",
                "description": "DTO representing a Entitlement End"
              }
            ],
            "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.PublicationCalendarResponse",
            "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.PublicationCalendarResponse[]",
            "isExpanded": true,
            "description": "DTO representing a publication calendar response"
          }
        ],
        "isExpanded": true,
        "statusCode": "204",
        "description": "No Content",
        "jsonExample": ""
      },
      {
        "isExpanded": true,
        "statusCode": "401",
        "description": "Not Authorized",
        "jsonExample": ""
      },
      {
        "isExpanded": true,
        "statusCode": "404",
        "description": "Product cannot be found",
        "jsonExample": ""
      },
      {
        "isExpanded": true,
        "statusCode": "500",
        "description": "Internal Server Error",
        "jsonExample": ""
      }
    ],
    "contentType": "application/json",
    "description": "This endpoint allows the ability to retrieve the specific configuration for how a product will be fulfilled.",
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.fictive.com/REST/api/products/{productReference}/schedules \\\n     --header 'accept: application/json' \\\n     --header 'x-version: string'"
        },
        {
          "id": "example-1-javascript",
          "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/products/{productReference}/schedules\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.fictive.com/REST/api/products/{productReference}/schedules\")\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": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.fictive.com/REST/api/products/{productReference}/schedules\"\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": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "[\n  {\n    \"scheduleReference\": \"001CA72IBXWWAV51M2\",\n    \"entitlementFormat\": \"EntitlementFormat1\",\n    \"friendlyName\": \"Example name 1\",\n    \"scheduleType\": \"Daily\",\n    \"dailySchedule\": {\n      \"issuingTime\": \"05:33\",\n      \"monday\": true,\n      \"tuesday\": true,\n      \"wednesday\": true,\n      \"thursday\": true,\n      \"friday\": true,\n      \"saturday\": false,\n      \"sunday\": false\n    },\n    \"nonIssuingDates\": [\n      \"2021-09-21\",\n      \"2021-11-21\"\n    ],\n    \"issuePriorToStart\": false,\n    \"entitlementEnds\": {\n      \"endsNever\": false,\n      \"endsAfterTimeUnit\": \"days\",\n      \"endsAfterNumberOfTimeUnits\": 2\n    }\n  },\n  {\n    \"scheduleReference\": \"001CAPXW95X1T69HK2\",\n    \"entitlementFormat\": \"EntitlementFormat2\",\n    \"friendlyName\": \"Example name 2\",\n    \"scheduleType\": \"Monthly\",\n    \"monthlySchedule\": {\n      \"issuingDay\": 21,\n      \"issuingTime\": \"05:33\"\n    },\n    \"nonIssuingDates\": [],\n    \"issuePriorToStart\": false,\n    \"entitlementEnds\": {\n      \"endsNever\": true\n    }\n  },\n  {\n    \"scheduleReference\": \"001CAS4VA3ZP3HYOU2\",\n    \"entitlementFormat\": \"EntitlementFormat3\",\n    \"friendlyName\": \"Example name 3\",\n    \"scheduleType\": \"Annual\",\n    \"annualSchedule\": {\n      \"issuingMonth\": \"September\",\n      \"issuingDay\": 21,\n      \"issuingTime\": \"05:33\"\n    },\n    \"nonIssuingDates\": [],\n    \"issuePriorToStart\": false,\n    \"entitlementEnds\": {\n      \"endsNever\": false,\n      \"endsDateTime\": \"2021-09-21T05:33:24.2917612\"\n    }\n  }\n]"
        },
        {
          "id": "response-1-204",
          "language": "204",
          "code": "// No Content\n[\n  {\n    \"scheduleReference\": \"\",\n    \"entitlementFormat\": \"\",\n    \"friendlyName\": \"\",\n    \"scheduleType\": \"\",\n    \"dailySchedule\": {\n      \"issuingTime\": \"\",\n      \"monday\": false,\n      \"tuesday\": false,\n      \"wednesday\": false,\n      \"thursday\": false,\n      \"friday\": false,\n      \"saturday\": false,\n      \"sunday\": false\n    },\n    \"monthlySchedule\": {\n      \"issuingDay\": \"\",\n      \"issuingTime\": \"\"\n    },\n    \"annualSchedule\": {\n      \"issuingMonth\": \"\",\n      \"issuingDay\": \"\",\n      \"issuingTime\": \"\"\n    },\n    \"customSchedule\": {\n      \"startDate\": \"2021-09-21T05:33:24.1511371\",\n      \"issuingFrequency\": \"\",\n      \"issuingUnit\": \"\"\n    },\n    \"irregularSchedule\": [\n      \"\"\n    ],\n    \"nonIssuingDates\": [\n      \"\"\n    ],\n    \"issuePriorToStart\": false,\n    \"entitlementEnds\": {\n      \"endsNever\": false,\n      \"endsAfterTimeUnit\": \"\",\n      \"endsAfterNumberOfTimeUnits\": \"\",\n      \"endsDateTime\": \"\"\n    }\n  }\n]"
        },
        {
          "id": "response-2-401",
          "language": "401",
          "code": "// Not Authorized\n"
        },
        {
          "id": "response-3-404",
          "language": "404",
          "code": "// Product 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": ""
    }
  ]
}