Skip to main content
GET
/
api
/
v1
/
renewal_decisions
Get renewal decisions
curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/renewal_decisions \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "offset": 1,
    "page_num": 2,
    "page_size": 2,
    "total_records": 1
  },
  "response": [
    {
      "body": {
        "carriers": [
          {
            "carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "lines_of_coverage": {
              "accident": {
                "open_enrollment_end_date": "2022-02-01",
                "open_enrollment_start_date": "2022-01-01",
                "plans": [
                  {
                    "name": "<string>",
                    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ]
              },
              "add": {
                "open_enrollment_end_date": "2022-02-01",
                "open_enrollment_start_date": "2022-01-01",
                "plans": [
                  {
                    "name": "<string>",
                    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ]
              },
              "cancer": {
                "open_enrollment_end_date": "2022-02-01",
                "open_enrollment_start_date": "2022-01-01",
                "plans": [
                  {
                    "name": "<string>",
                    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ]
              },
              "critical_illness": {
                "open_enrollment_end_date": "2022-02-01",
                "open_enrollment_start_date": "2022-01-01",
                "plans": [
                  {
                    "name": "<string>",
                    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ]
              },
              "dental": {
                "open_enrollment_end_date": "2022-02-01",
                "open_enrollment_start_date": "2022-01-01",
                "plans": [
                  {
                    "name": "<string>",
                    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ]
              },
              "health_fund": {
                "open_enrollment_end_date": "2022-02-01",
                "open_enrollment_start_date": "2022-01-01",
                "plans": [
                  {
                    "name": "<string>",
                    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ]
              },
              "hospital_indemnity": {
                "open_enrollment_end_date": "2022-02-01",
                "open_enrollment_start_date": "2022-01-01",
                "plans": [
                  {
                    "name": "<string>",
                    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ]
              },
              "life": {
                "open_enrollment_end_date": "2022-02-01",
                "open_enrollment_start_date": "2022-01-01",
                "plans": [
                  {
                    "name": "<string>",
                    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ]
              },
              "ltd": {
                "open_enrollment_end_date": "2022-02-01",
                "open_enrollment_start_date": "2022-01-01",
                "plans": [
                  {
                    "name": "<string>",
                    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ]
              },
              "medical": {
                "open_enrollment_end_date": "2022-02-01",
                "open_enrollment_start_date": "2022-01-01",
                "plans": [
                  {
                    "name": "<string>",
                    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ]
              },
              "pharmacy": {
                "open_enrollment_end_date": "2022-02-01",
                "open_enrollment_start_date": "2022-01-01",
                "plans": [
                  {
                    "name": "<string>",
                    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ]
              },
              "std": {
                "open_enrollment_end_date": "2022-02-01",
                "open_enrollment_start_date": "2022-01-01",
                "plans": [
                  {
                    "name": "<string>",
                    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ]
              },
              "vision": {
                "open_enrollment_end_date": "2022-02-01",
                "open_enrollment_start_date": "2022-01-01",
                "plans": [
                  {
                    "name": "<string>",
                    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ]
              },
              "wellness": {
                "open_enrollment_end_date": "2022-02-01",
                "open_enrollment_start_date": "2022-01-01",
                "plans": [
                  {
                    "name": "<string>",
                    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ]
              }
            }
          }
        ]
      },
      "created": 123,
      "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "issues": [
        {
          "level": "warning",
          "message": "<string>",
          "carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "line_of_coverage": "<string>"
        }
      ],
      "modified": 123,
      "renewal_date": "2023-12-25",
      "status": "submitted",
      "version": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

group_name
string<string>

Group name to filter by, exact match

Example:

"Company Inc"

status
string<string>

Status to filter by, exact match

Example:

"ready"

start_date
string<date>

Filter request by renewal date starting from date provided

Example:

"Mon, 01 Jan 2024 00:00:00 GMT"

end_date
string<date>

Filter request by renewal date up to date provided

Example:

"Mon, 01 Jan 2024 00:00:00 GMT"

Response

200 - application/json

Successful Response - Returns the found renewal decisions.

meta
object
required

Metadata associated with the response data

response
object[]
required

List of renewal decisions