API Overview

The GoWell Insurance Enrollment Web API provides a set of RESTful endpoints that allow you to manage the entire insurance enrollment process. This overview will help you understand the structure and capabilities of our API.

Base URL

All API requests should be made to:

https://api.gowell-insurance.com/v1

Available Endpoints

Our API is organized around the following main resources:

Customers

  • GET /customers: Retrieve a list of customers
  • GET /customers/{id}: Retrieve a specific customer
  • POST /customers: Create a new customer
  • PUT /customers/{id}: Update an existing customer
  • DELETE /customers/{id}: Delete a customer

Plans

  • GET /plans: Retrieve a list of available insurance plans
  • GET /plans/{id}: Retrieve details of a specific plan

Enrollments

  • POST /enrollments: Create a new enrollment
  • GET /enrollments/{id}: Retrieve details of a specific enrollment
  • PUT /enrollments/{id}: Update an existing enrollment
  • DELETE /enrollments/{id}: Cancel an enrollment

Quotes

  • POST /quotes: Generate a quote for a given plan and customer
  • GET /quotes/{id}: Retrieve a previously generated quote

Request/Response Format

Our API accepts and returns data in JSON format. Ensure that your requests include the appropriate headers:

Content-Type: application/json
Accept: application/json

Pagination

For endpoints that return lists of items, we use cursor-based pagination. Use the cursor and limit query parameters to navigate through the results.

Example:

GET /customers?cursor=eyJpZCI6MTAwfQ==&limit=50

Error Handling

Our API uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

  • 2xx range indicate success
  • 4xx range indicate an error that failed given the information provided
  • 5xx range indicate an error with our servers

For more details on specific error codes and messages, please refer to our Error Handling Guide.

Rate Limiting

To ensure the stability and availability of our API, we implement rate limiting. The current limits are:

  • 1000 requests per hour
  • 10 requests per second

If you exceed these limits, you'll receive a 429 Too Many Requests response.

Webhooks

We provide webhooks for real-time notifications about important events. To learn more about setting up and using webhooks, see our Webhooks Guide.

For detailed information about each endpoint, including request/response examples, please refer to our API Reference.