GET api/company?showGroups={showGroups}
Gets the company information for the authenticated user
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| showGroups |
Optional querystring variable that will return all groups asscoiated with the company. The default is true. |
boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Returns the company information along with the corresponding groups.
CompanyModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyName |
Company Name |
string |
None. |
| RuleChangeNoteRequired |
Indicates if rule changes require a note for the change |
boolean |
None. |
| Groups |
A list of groups associated with the Company |
Collection of GroupModel |
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 3",
"id": 4,
"companyName": "sample string 1",
"ruleChangeNoteRequired": true,
"groups": [
{
"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-30T20:58:59.3246772-05:00",
"effectiveEndDate": "2025-05-30T20:58:59.3246772-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-30T20:58:59.3246772-05:00",
"effectiveEndDate": "2025-05-30T20:58:59.3246772-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-30T20:58:59.3246772-05:00",
"effectiveEndDate": "2025-05-30T20:58:59.3246772-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-30T20:58:59.3246772-05:00",
"effectiveEndDate": "2025-05-30T20:58:59.3246772-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
}
]
}
]
}