Organization Bundles API Documentation

Overview

The Organization Bundles API enables third-party applications to list product bundles available for an organization and fetch detailed bundle information optionally including associated forms.

Base URLs

• Production: https://api.care360-next.carevalidate.com/api/v1/organization
• Staging: https://api-staging.care360-next.carevalidate.com/api/v1/organization

Authentication is via organization secret key provided by CareValidate.

Authentication

Required Headers

Header	Type	Required	Description
cv-api-key	string	Yes	Organization API key provided by CareValidate
Accept	string	Optional	Response format. Use application/json

If cv-api-key is missing or invalid, the API returns HTTP 400 with a validation error message.

---

List Bundles

Endpoint

GET /api/v1/organization/bundles

Query Parameters

Parameter	Type	Required	Allowed values	Description
isVisible	boolean string	Optional	true, false	Filter bundles by visibility. Omit to return all

Success Response

{
  "status": 200,
  "success": true,
  "message": "Products return successfully",
  "data": [
    {
      "id": "bundle-uuid",
      "name": "Weight Loss Program",
      "imageUrl": "https://.../bundle.png",
      "description": "Program description",
      "price": "99.99",
      "priceUnit": "USD",
      "initialDiscount": "10.00",
      "isSoldOut": false,
      "isVisible": true
    }
  ]
}

Error Responses

• 400 Validation error

{
  "status": 400,
  "success": false,
  "message": "Invalid request parameters",
  "error": "..."
}

• 500 Internal error

{
  "status": 500,
  "success": false,
  "message": "Internal server error",
  "error": "..."
}

cURL Example

curl -X GET 'https://api.care360-next.carevalidate.com/api/v1/organization/bundles?isVisible=true' \
  -H 'cv-api-key: YOUR_SECRET_KEY_HERE' \
  -H 'Accept: application/json'

---

Get Bundle by ID

Endpoint

GET /api/v1/organization/bundles/:bundleUUID

Path Parameters

Parameter	Type	Required	Description
bundleUUID	string (UUID)	Yes	UUID of the bundle

Query Parameters

Parameter	Type	Required	Allowed values	Description
includeIntakeForm	boolean string	Optional	true, false	Include intake form details
includeFollowupForm	boolean string	Optional	true, false	Include follow-up form details

Success Response (no forms)

{
  "status": 200,
  "success": true,
  "message": "Bundle return successfully",
  "data": {
    "bundle": {
      "id": "bundle-uuid",
      "name": "Weight Loss Program",
      "imageUrl": "https://.../bundle.png",
      "description": "Program description",
      "price": "99.99",
      "priceUnit": "USD",
      "initialDiscount": "10.00",
      "isSoldOut": false,
      "isVisible": true
    }
  }
}

Success Response (with forms when requested)

{
  "status": 200,
  "success": true,
  "message": "Bundle return successfully",
  "data": {
    "bundle": { "id": "...", "name": "...", "imageUrl": "...", "description": "...", "price": "...", "priceUnit": "USD", "initialDiscount": "...", "isSoldOut": false, "isVisible": true },
    "intakeForm": {
      "id": "form-uuid",
      "name": "Intake Form",
      "description": "...",
      "isActive": true,
      "questions": [
        {
          "hint": "...",
          "id": "question-uuid",
          "isPHI": false,
          "options": ["Option 1", "Option 2"],
          "placeholder": "...",
          "required": true,
          "text": "Question text",
          "type": "TEXT",
          "renderMode": null,
          "index": 0,
          "condition": null,
          "organizationDocument": null
        }
      ]
    },
    "followupForm": {
      "id": "form-uuid",
      "name": "Follow-up Form",
      "description": "...",
      "isActive": true,
      "questions": [ { "id": "..." } ]
    }
  }
}

Error Responses

• 400 Validation error (e.g., missing key or invalid booleans)

{
  "status": 400,
  "success": false,
  "message": "Invalid request parameters",
  "error": "..."
}

• 400 Not found

{
  "status": 400,
  "success": false,
  "error": "Bundle with ID 00000000-0000-0000-0000-000000000000 not found"
}

• 500 Internal error

{
  "status": 500,
  "success": false,
  "message": "Internal server error",
  "error": "..."
}

cURL Examples

• Without forms

curl -X GET 'https://api.care360-next.carevalidate.com/api/v1/organization/bundles/3b67583d-e17b-44de-8811-bdf520b99425' \
  -H 'cv-api-key: YOUR_SECRET_KEY_HERE' \
  -H 'Accept: application/json'

• With intake and follow-up forms

curl -X GET 'https://api.care360-next.carevalidate.com/api/v1/organization/bundles/3b67583d-e17b-44de-8811-bdf520b99425?includeIntakeForm=true&includeFollowupForm=true' \
  -H 'cv-api-key: YOUR_SECRET_KEY_HERE' \
  -H 'Accept: application/json'

---

Changelog

Version	Date	Changes
1.0	2025-09-09	Initial bundles API documentation