GET api/groups?showGroupPlans={showGroupPlans}

Gets a collection of Groups based on the company associated with the authenticated user
Request Information

URI Parameters

Name	Description	Type	Additional information
showGroupPlans	Flag whether to show the associated group plans	boolean	Default value is True
Body Parameters

None.
Response Information

Resource Description

A list of Groups and optionally their corresponding plan(s)
Collection of GroupModel
Name	Description	Type	Additional information
GroupName	Gets or sets the name of the location representing the group	string	None.
GroupPlans	Gets or sets the list of Group Plans utilized by the Group	Collection of GroupPlanModel	None.
Url	Gets or sets the link representing a link back to the resource	string	None.
ID	Gets or sets the identifier for the resource	integer	None.
Response Formats

application/json, text/json, application/json-patch+json

Sample:
[
  {
    "url": "sample string 2",
    "id": 3,
    "groupName": "sample string 1",
    "groupPlans": [
      {
        "url": "sample string 34",
        "id": 35,
        "planContractsUrl": "sample string 1",
        "deductiblesUrl": "sample string 2",
        "maxOutOfPocketsUrl": "sample string 3",
        "planBenefitLimitsUrl": "sample string 4",
        "planIncentivesUrl": "sample string 5",
        "appliedNetworksUrl": "sample string 6",
        "appliedPharmacyHeadquarterExceptionsUrl": "sample string 7",
        "planPricingGroupsUrl": "sample string 8",
        "groupNo": 1,
        "planName": "sample string 9",
        "groupName": "sample string 10",
        "description": "sample string 11",
        "bin": "sample string 12",
        "pcn": "sample string 13",
        "validatePCN": true,
        "effectiveStartDate": "2025-05-30T21:03:15.1345844-05:00",
        "effectiveEndDate": "2025-05-30T21:03:15.1345844-05:00",
        "basePerDiemUrl": "sample string 14",
        "basePerDiemNo": 1,
        "newStartDays": 1,
        "maxClaimDays": 1,
        "maxReversalDays": 1,
        "defaultDrugTier": 64,
        "enforceFormularyLimits": true,
        "standardMessage": "sample string 15",
        "approveMessage": "sample string 16",
        "requiredOverrideMessage": "sample string 17",
        "notCoveredMessage": "sample string 18",
        "outOfPocketMessage": "sample string 19",
        "helpDeskPhoneNumber": "sample string 20",
        "unknownDispenseFee": 1.0,
        "unknownUseSubmittedDispenseFee": true,
        "unknownUseUsualAndCustomary": true,
        "unknownUseGrossAmountDue": true,
        "unknownCoinsuranceUrl": "sample string 21",
        "unknownCoinsuranceNo": 1,
        "unknownOutOfPocketCoinsuranceUrl": "sample string 22",
        "unknownOutOfPocketCoinsuranceNo": 1,
        "compoundPriceSubmittedDrugs": true,
        "compoundRequireValidNDC": true,
        "compoundMinimumDrugsToPrice": 64,
        "compoundMaxDrugsToPrice": 64,
        "compoundMinimumPrice": 1.0,
        "compoundDefaultFee": 1.0,
        "compoundEffort1Fee": 1.0,
        "compoundEffort2Fee": 1.0,
        "compoundEffort3Fee": 1.0,
        "compoundEffort4Fee": 1.0,
        "compoundEffort5Fee": 1.0,
        "compoundUseSubmittedDispenseFee": true,
        "compoundUseUsualAndCustomary": true,
        "compoundUseGrossAmountDue": true,
        "compoundCoinsuranceUrl": "sample string 23",
        "compoundCoinsuranceNo": 1,
        "compoundOutOfPocketCoinsuranceUrl": "sample string 24",
        "compoundOutOfPocketCoinsuranceNo": 1,
        "compoundDrugPricingUrl": "sample string 25",
        "compoundDrugPricingNo": 1,
        "altCompoundDrugPricingNo": 1,
        "altCompoundDrugPricingUrl": "sample string 26",
        "unknownDrugPricingUrl": "sample string 27",
        "unknownDrugPricingNo": 1,
        "useNetworkCoinsurance": true,
        "useNetworkIncentive": true,
        "useNetworkDeductibleOptions": true,
        "durDrugDrugCheck": true,
        "durDrugDrugLevelSeverity": "sample string 28",
        "durDrugDrugMessage": "sample string 29",
        "durDrugDrugActionTypeNo": 1,
        "mmeActionTypeNo": 1,
        "mmeThresholdCheck": true,
        "mmeThreshold": 1,
        "mmeResponseMessage": "sample string 30",
        "allowFutureDateOfService": true,
        "defaultPharmacyTier": "sample string 31",
        "templateOverrideOptions": true,
        "templateOverrideMessages": true,
        "templateOverridePrescriptionEdits": true,
        "templateOverrideDUR": true,
        "templateOverrideCompoundPricing": true,
        "templateOverrideUnknownPricing": true,
        "templateOverrideFormulary": true,
        "templateOverrideGlobalPricing": true,
        "returnMemberLookupMessages": true,
        "subscribeToGlobalPricingACI": true,
        "subscribeToGlobalPricingAcqCost": true,
        "subscribeToGlobalPricingCustomMAC": true,
        "subscribeToGlobalPricingRefPrice": true,
        "rxExpireDays": 1,
        "prescriberGraceDays": 1,
        "eligibilityRejectMessage": "sample string 32",
        "prescriptionWrittenMaxDays": 1,
        "rejectClaimIfNoCustomPrice": true,
        "planTemplateNo": 1,
        "planTemplateUrl": "sample string 33",
        "planIncentiveLimitAmountPeriod": 1.0,
        "planIncentiveLimitAmountMonth": 1.0,
        "planIncentiveLimitMonthRollover": true
      },
      {
        "url": "sample string 34",
        "id": 35,
        "planContractsUrl": "sample string 1",
        "deductiblesUrl": "sample string 2",
        "maxOutOfPocketsUrl": "sample string 3",
        "planBenefitLimitsUrl": "sample string 4",
        "planIncentivesUrl": "sample string 5",
        "appliedNetworksUrl": "sample string 6",
        "appliedPharmacyHeadquarterExceptionsUrl": "sample string 7",
        "planPricingGroupsUrl": "sample string 8",
        "groupNo": 1,
        "planName": "sample string 9",
        "groupName": "sample string 10",
        "description": "sample string 11",
        "bin": "sample string 12",
        "pcn": "sample string 13",
        "validatePCN": true,
        "effectiveStartDate": "2025-05-30T21:03:15.1345844-05:00",
        "effectiveEndDate": "2025-05-30T21:03:15.1345844-05:00",
        "basePerDiemUrl": "sample string 14",
        "basePerDiemNo": 1,
        "newStartDays": 1,
        "maxClaimDays": 1,
        "maxReversalDays": 1,
        "defaultDrugTier": 64,
        "enforceFormularyLimits": true,
        "standardMessage": "sample string 15",
        "approveMessage": "sample string 16",
        "requiredOverrideMessage": "sample string 17",
        "notCoveredMessage": "sample string 18",
        "outOfPocketMessage": "sample string 19",
        "helpDeskPhoneNumber": "sample string 20",
        "unknownDispenseFee": 1.0,
        "unknownUseSubmittedDispenseFee": true,
        "unknownUseUsualAndCustomary": true,
        "unknownUseGrossAmountDue": true,
        "unknownCoinsuranceUrl": "sample string 21",
        "unknownCoinsuranceNo": 1,
        "unknownOutOfPocketCoinsuranceUrl": "sample string 22",
        "unknownOutOfPocketCoinsuranceNo": 1,
        "compoundPriceSubmittedDrugs": true,
        "compoundRequireValidNDC": true,
        "compoundMinimumDrugsToPrice": 64,
        "compoundMaxDrugsToPrice": 64,
        "compoundMinimumPrice": 1.0,
        "compoundDefaultFee": 1.0,
        "compoundEffort1Fee": 1.0,
        "compoundEffort2Fee": 1.0,
        "compoundEffort3Fee": 1.0,
        "compoundEffort4Fee": 1.0,
        "compoundEffort5Fee": 1.0,
        "compoundUseSubmittedDispenseFee": true,
        "compoundUseUsualAndCustomary": true,
        "compoundUseGrossAmountDue": true,
        "compoundCoinsuranceUrl": "sample string 23",
        "compoundCoinsuranceNo": 1,
        "compoundOutOfPocketCoinsuranceUrl": "sample string 24",
        "compoundOutOfPocketCoinsuranceNo": 1,
        "compoundDrugPricingUrl": "sample string 25",
        "compoundDrugPricingNo": 1,
        "altCompoundDrugPricingNo": 1,
        "altCompoundDrugPricingUrl": "sample string 26",
        "unknownDrugPricingUrl": "sample string 27",
        "unknownDrugPricingNo": 1,
        "useNetworkCoinsurance": true,
        "useNetworkIncentive": true,
        "useNetworkDeductibleOptions": true,
        "durDrugDrugCheck": true,
        "durDrugDrugLevelSeverity": "sample string 28",
        "durDrugDrugMessage": "sample string 29",
        "durDrugDrugActionTypeNo": 1,
        "mmeActionTypeNo": 1,
        "mmeThresholdCheck": true,
        "mmeThreshold": 1,
        "mmeResponseMessage": "sample string 30",
        "allowFutureDateOfService": true,
        "defaultPharmacyTier": "sample string 31",
        "templateOverrideOptions": true,
        "templateOverrideMessages": true,
        "templateOverridePrescriptionEdits": true,
        "templateOverrideDUR": true,
        "templateOverrideCompoundPricing": true,
        "templateOverrideUnknownPricing": true,
        "templateOverrideFormulary": true,
        "templateOverrideGlobalPricing": true,
        "returnMemberLookupMessages": true,
        "subscribeToGlobalPricingACI": true,
        "subscribeToGlobalPricingAcqCost": true,
        "subscribeToGlobalPricingCustomMAC": true,
        "subscribeToGlobalPricingRefPrice": true,
        "rxExpireDays": 1,
        "prescriberGraceDays": 1,
        "eligibilityRejectMessage": "sample string 32",
        "prescriptionWrittenMaxDays": 1,
        "rejectClaimIfNoCustomPrice": true,
        "planTemplateNo": 1,
        "planTemplateUrl": "sample string 33",
        "planIncentiveLimitAmountPeriod": 1.0,
        "planIncentiveLimitAmountMonth": 1.0,
        "planIncentiveLimitMonthRollover": true
      }
    ]
  },
  {
    "url": "sample string 2",
    "id": 3,
    "groupName": "sample string 1",
    "groupPlans": [
      {
        "url": "sample string 34",
        "id": 35,
        "planContractsUrl": "sample string 1",
        "deductiblesUrl": "sample string 2",
        "maxOutOfPocketsUrl": "sample string 3",
        "planBenefitLimitsUrl": "sample string 4",
        "planIncentivesUrl": "sample string 5",
        "appliedNetworksUrl": "sample string 6",
        "appliedPharmacyHeadquarterExceptionsUrl": "sample string 7",
        "planPricingGroupsUrl": "sample string 8",
        "groupNo": 1,
        "planName": "sample string 9",
        "groupName": "sample string 10",
        "description": "sample string 11",
        "bin": "sample string 12",
        "pcn": "sample string 13",
        "validatePCN": true,
        "effectiveStartDate": "2025-05-30T21:03:15.1345844-05:00",
        "effectiveEndDate": "2025-05-30T21:03:15.1345844-05:00",
        "basePerDiemUrl": "sample string 14",
        "basePerDiemNo": 1,
        "newStartDays": 1,
        "maxClaimDays": 1,
        "maxReversalDays": 1,
        "defaultDrugTier": 64,
        "enforceFormularyLimits": true,
        "standardMessage": "sample string 15",
        "approveMessage": "sample string 16",
        "requiredOverrideMessage": "sample string 17",
        "notCoveredMessage": "sample string 18",
        "outOfPocketMessage": "sample string 19",
        "helpDeskPhoneNumber": "sample string 20",
        "unknownDispenseFee": 1.0,
        "unknownUseSubmittedDispenseFee": true,
        "unknownUseUsualAndCustomary": true,
        "unknownUseGrossAmountDue": true,
        "unknownCoinsuranceUrl": "sample string 21",
        "unknownCoinsuranceNo": 1,
        "unknownOutOfPocketCoinsuranceUrl": "sample string 22",
        "unknownOutOfPocketCoinsuranceNo": 1,
        "compoundPriceSubmittedDrugs": true,
        "compoundRequireValidNDC": true,
        "compoundMinimumDrugsToPrice": 64,
        "compoundMaxDrugsToPrice": 64,
        "compoundMinimumPrice": 1.0,
        "compoundDefaultFee": 1.0,
        "compoundEffort1Fee": 1.0,
        "compoundEffort2Fee": 1.0,
        "compoundEffort3Fee": 1.0,
        "compoundEffort4Fee": 1.0,
        "compoundEffort5Fee": 1.0,
        "compoundUseSubmittedDispenseFee": true,
        "compoundUseUsualAndCustomary": true,
        "compoundUseGrossAmountDue": true,
        "compoundCoinsuranceUrl": "sample string 23",
        "compoundCoinsuranceNo": 1,
        "compoundOutOfPocketCoinsuranceUrl": "sample string 24",
        "compoundOutOfPocketCoinsuranceNo": 1,
        "compoundDrugPricingUrl": "sample string 25",
        "compoundDrugPricingNo": 1,
        "altCompoundDrugPricingNo": 1,
        "altCompoundDrugPricingUrl": "sample string 26",
        "unknownDrugPricingUrl": "sample string 27",
        "unknownDrugPricingNo": 1,
        "useNetworkCoinsurance": true,
        "useNetworkIncentive": true,
        "useNetworkDeductibleOptions": true,
        "durDrugDrugCheck": true,
        "durDrugDrugLevelSeverity": "sample string 28",
        "durDrugDrugMessage": "sample string 29",
        "durDrugDrugActionTypeNo": 1,
        "mmeActionTypeNo": 1,
        "mmeThresholdCheck": true,
        "mmeThreshold": 1,
        "mmeResponseMessage": "sample string 30",
        "allowFutureDateOfService": true,
        "defaultPharmacyTier": "sample string 31",
        "templateOverrideOptions": true,
        "templateOverrideMessages": true,
        "templateOverridePrescriptionEdits": true,
        "templateOverrideDUR": true,
        "templateOverrideCompoundPricing": true,
        "templateOverrideUnknownPricing": true,
        "templateOverrideFormulary": true,
        "templateOverrideGlobalPricing": true,
        "returnMemberLookupMessages": true,
        "subscribeToGlobalPricingACI": true,
        "subscribeToGlobalPricingAcqCost": true,
        "subscribeToGlobalPricingCustomMAC": true,
        "subscribeToGlobalPricingRefPrice": true,
        "rxExpireDays": 1,
        "prescriberGraceDays": 1,
        "eligibilityRejectMessage": "sample string 32",
        "prescriptionWrittenMaxDays": 1,
        "rejectClaimIfNoCustomPrice": true,
        "planTemplateNo": 1,
        "planTemplateUrl": "sample string 33",
        "planIncentiveLimitAmountPeriod": 1.0,
        "planIncentiveLimitAmountMonth": 1.0,
        "planIncentiveLimitMonthRollover": true
      },
      {
        "url": "sample string 34",
        "id": 35,
        "planContractsUrl": "sample string 1",
        "deductiblesUrl": "sample string 2",
        "maxOutOfPocketsUrl": "sample string 3",
        "planBenefitLimitsUrl": "sample string 4",
        "planIncentivesUrl": "sample string 5",
        "appliedNetworksUrl": "sample string 6",
        "appliedPharmacyHeadquarterExceptionsUrl": "sample string 7",
        "planPricingGroupsUrl": "sample string 8",
        "groupNo": 1,
        "planName": "sample string 9",
        "groupName": "sample string 10",
        "description": "sample string 11",
        "bin": "sample string 12",
        "pcn": "sample string 13",
        "validatePCN": true,
        "effectiveStartDate": "2025-05-30T21:03:15.1345844-05:00",
        "effectiveEndDate": "2025-05-30T21:03:15.1345844-05:00",
        "basePerDiemUrl": "sample string 14",
        "basePerDiemNo": 1,
        "newStartDays": 1,
        "maxClaimDays": 1,
        "maxReversalDays": 1,
        "defaultDrugTier": 64,
        "enforceFormularyLimits": true,
        "standardMessage": "sample string 15",
        "approveMessage": "sample string 16",
        "requiredOverrideMessage": "sample string 17",
        "notCoveredMessage": "sample string 18",
        "outOfPocketMessage": "sample string 19",
        "helpDeskPhoneNumber": "sample string 20",
        "unknownDispenseFee": 1.0,
        "unknownUseSubmittedDispenseFee": true,
        "unknownUseUsualAndCustomary": true,
        "unknownUseGrossAmountDue": true,
        "unknownCoinsuranceUrl": "sample string 21",
        "unknownCoinsuranceNo": 1,
        "unknownOutOfPocketCoinsuranceUrl": "sample string 22",
        "unknownOutOfPocketCoinsuranceNo": 1,
        "compoundPriceSubmittedDrugs": true,
        "compoundRequireValidNDC": true,
        "compoundMinimumDrugsToPrice": 64,
        "compoundMaxDrugsToPrice": 64,
        "compoundMinimumPrice": 1.0,
        "compoundDefaultFee": 1.0,
        "compoundEffort1Fee": 1.0,
        "compoundEffort2Fee": 1.0,
        "compoundEffort3Fee": 1.0,
        "compoundEffort4Fee": 1.0,
        "compoundEffort5Fee": 1.0,
        "compoundUseSubmittedDispenseFee": true,
        "compoundUseUsualAndCustomary": true,
        "compoundUseGrossAmountDue": true,
        "compoundCoinsuranceUrl": "sample string 23",
        "compoundCoinsuranceNo": 1,
        "compoundOutOfPocketCoinsuranceUrl": "sample string 24",
        "compoundOutOfPocketCoinsuranceNo": 1,
        "compoundDrugPricingUrl": "sample string 25",
        "compoundDrugPricingNo": 1,
        "altCompoundDrugPricingNo": 1,
        "altCompoundDrugPricingUrl": "sample string 26",
        "unknownDrugPricingUrl": "sample string 27",
        "unknownDrugPricingNo": 1,
        "useNetworkCoinsurance": true,
        "useNetworkIncentive": true,
        "useNetworkDeductibleOptions": true,
        "durDrugDrugCheck": true,
        "durDrugDrugLevelSeverity": "sample string 28",
        "durDrugDrugMessage": "sample string 29",
        "durDrugDrugActionTypeNo": 1,
        "mmeActionTypeNo": 1,
        "mmeThresholdCheck": true,
        "mmeThreshold": 1,
        "mmeResponseMessage": "sample string 30",
        "allowFutureDateOfService": true,
        "defaultPharmacyTier": "sample string 31",
        "templateOverrideOptions": true,
        "templateOverrideMessages": true,
        "templateOverridePrescriptionEdits": true,
        "templateOverrideDUR": true,
        "templateOverrideCompoundPricing": true,
        "templateOverrideUnknownPricing": true,
        "templateOverrideFormulary": true,
        "templateOverrideGlobalPricing": true,
        "returnMemberLookupMessages": true,
        "subscribeToGlobalPricingACI": true,
        "subscribeToGlobalPricingAcqCost": true,
        "subscribeToGlobalPricingCustomMAC": true,
        "subscribeToGlobalPricingRefPrice": true,
        "rxExpireDays": 1,
        "prescriberGraceDays": 1,
        "eligibilityRejectMessage": "sample string 32",
        "prescriptionWrittenMaxDays": 1,
        "rejectClaimIfNoCustomPrice": true,
        "planTemplateNo": 1,
        "planTemplateUrl": "sample string 33",
        "planIncentiveLimitAmountPeriod": 1.0,
        "planIncentiveLimitAmountMonth": 1.0,
        "planIncentiveLimitMonthRollover": true
      }
    ]
  }
]