# Get Groups

Gets Groups

Endpoint: GET /groups/{groupID}
Version: v1
Security: apiKeyAuth, bearerAuth

## Security:

  - `apiKeyAuth` (unknown)
    apiKey in header x-api-key

  - `bearerAuth` (unknown)
    http bearer JWT

## Path parameters:

  - `groupID` (string, required)
    Group ID

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Response 200:

  - `200` (unknown)
    Success

## Response 200 fields (application/json):

  - `data` (object)

  - `data.group_ID` (string, required)
    Unique identifier for each Group.

  - `data.account_Key` (integer)
    Identifies the Account associated with this Group.

  - `data.account_Manager` (string)
    Information field used in custom client reporting.

  - `data.addOn_Rate_Option` (string)
    Determines whether a Group's AddOn Rates are combined and applied once (Additive) or applies rates separately, in a sequence (Sequential).

  - `data.address` (string)
    Adderss of the Group.

  - `data.address2` (string)
    Line 2 of the Group's address.

  - `data.admin_COBRA` (boolean, required)
    Indicates if this Group administers COBRA. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.adult_Age` (integer)
    Identifies the age at which dependents are considered to be adults. Student status information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here.

  - `data.advice_To_Pay` (boolean, required)
    Notes if the claims for this Group should be Advice_To_Pay (flagged as unpaid when processed). Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.apply_Ex_Code` (boolean, required)
    Flag if adjudication should apply an Ex Code to a claim for this Group. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.auth_Not_Reqd_Override` (boolean, required)
    Notes if this group allows Auth Required claims edit to be overridden and paid. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.billing_Age_Calc` (string)
    No longer in use. Replaced by Premium Billing module.

  - `data.billing_Cycle_ID` (string)
    Identifies the bill cycle for this Group. This will be used when creating invoices.

  - `data.billing_Due_Date_Range` (integer)
    Used when Set_Billing_Due_Date is enabled.

  - `data.billing_Due_Date_Range_Type` (string)
    Used when Set_Billing_Due_Date is enabled.

  - `data.billing_Due_Date_Type` (string)
    Used when Set_Billing_Due_Date is enabled.

  - `data.billing_Invoice_Create` (integer)
    Indicates the group is included in invoice generation processes.

  - `data.billing_Retro_Limit` (integer)
    Indicates how many bills (based on billing cycles) should be interrogated to determine adjustments.

  - `data.caseRate` (number)
    No longer in use.

  - `data.check_Birthday` (string)
    Identifies whether date of birth edits are performed for this Group during adjudication.

  - `data.city` (string)
    City of the Group's address.

  - `data.claim_Days_Allowed` (integer)
    No longer in use.

  - `data.coPay_Max_Per_Date_Provider` (boolean, required)
    Notes that this group calculates copay max (based on plan configuration) by provider rather than across the entire plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.commission_Lookback` (integer)
    Notes the number of billing cycles to lookback when calculating commissions.

  - `data.contact_Country_Code` (string)
    Country code of the Group's contact number.

  - `data.contact_Email_Address` (string)
    Email address of the identified Group contact.

  - `data.contact_Extension` (string)
    Extension number of the Group's contact.

  - `data.contact_Phone` (string)
    Phone number of the Group's contact.

  - `data.contact_Title` (string)
    Title of the Group's primary contact.

  - `data.country_ID` (string)
    Identifier of the Groups's country.

  - `data.county_Code` (string)
    County code of the Group address.

  - `data.cutoff_Age` (integer)
    Identifies the age at which dependents are no longer eligible for coverage. Adult Dependent information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here.

  - `data.default_EOB_Report` (integer)
    Defines the default EOB report object from our core admin system. This is a developer setting.

  - `data.default_Invoice_ReportDefinition_Key` (integer)
    By default, indicates which Invoice report should be used for automation.

  - `data.default_Process_by_Disability_Date` (boolean, required)
    Process by Disability Date can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default). Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.default_Roll_Up_Waiting_Period` (boolean, required)
    Roll Up Waiting Period can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default). Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.disability_Pay_Through_Day` (integer)
    The day of the week that Paid Through is calculated for Disability premiums.

  - `data.disable_COBRA_Auto_Select` (boolean, required)
    This flag indicates that the Group COBRA premium will not be automatically populated during member disenrollment. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.disenroll_Date` (string)
    Date when the Group expires/expired.

  - `data.distribution_Account_Key` (integer)
    For Premium Distribution processing, this notes the Account for the source of distributed funds.

  - `data.distribution_Payor_ID` (string)
    For Premium Distribution processing, this notes the Payor ID for the source of distributed funds.

  - `data.duplicate_Claim_Override` (boolean, required)
    Notes if this group allows Duplicate Claims to be overridden to be paid. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.election_Range` (integer)
    Used for determining Flex Election.

  - `data.election_Range_Type` (string)
    Used with Election_Range to determine the Flex Election.

  - `data.employer_Size` (string)
    Information field used in custom client reporting.

  - `data.entry_Date` (string)
    Date when the record was first added to the system.

  - `data.entry_User` (string)
    User that first added the record to the system.

  - `data.ex_Code` (string)
    The Ex Code applied during claims adjudication if "Apply_Ex_Code" is enabled.

  - `data.fax` (string)
    Fax number of the Group.

  - `data.fax_Country_Code` (string)
    Country code of the Group's fax number.

  - `data.federal_ID` (string)
    Federal tax identifier of the Group.

  - `data.generate_Adjustments` (string)
    No longer in use. Replaced by Premium Billing module.

  - `data.generate_Invoices` (string)
    No longer in use. Replaced by Premium Billing module.

  - `data.group_Account` (integer)
    Holds the account reference for the Employer Account. Not used in processing.

  - `data.individual_Billing` (boolean, required)
    No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.individual_Cycle` (boolean, required)
    No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.individual_Dates` (boolean, required)
    No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.inv_Grace_Period` (integer)
    The grace period value based on "Grace_Period_Type" for how long you have to process an invoice after the term date.

  - `data.inv_Grace_Period_Type` (string)
    Works with Grace_Period to determine how long after term date an invoice can be processed.

  - `data.invoice_Enrolled_By` (integer)
    Used to determine eligiblity during invoice generation for enrolled members.

  - `data.invoice_Enrolled_Thru` (integer)
    Used to determine eligiblity during invoice generation for enrolled members.

  - `data.issue_State` (string)
    Identifies the sate in which the Group is insured.

  - `data.name` (string)
    Name of the Group.

  - `data.notes` (string)
    No longer in use, replaced by Notes Service.

  - `data.open_Closed_Enrollment` (boolean, required)
    Information field used in custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.original_Date` (string)
    Date when the Group becomes/became active.

  - `data.paid_Through` (string)
    Date through which the Group premium has been paid.

  - `data.paperless` (boolean, required)
    Notes if this Group is Paperless (this overrides the individual member settings from VBAGateway). Used in process automation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.pay_To_Account` (integer)
    The Pay To Account used for external payments.

  - `data.payor_ID` (string)
    Identifier of the Payor associated with the Group.

  - `data.phone` (string)
    Phone number of the Group.

  - `data.phone_Country_Code` (string)
    Country code of the Group's phone number.

  - `data.prepaid_Group` (boolean, required)
    Information field used in custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.primary_Contact` (string)
    Primary contact of the Group.

  - `data.producer` (string)
    Information field used in custom client reporting.

  - `data.prorate_Deduction` (boolean, required)
    Notes if the disability deductions should be prorated during adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.prorate_Deduction_Type` (string)
    For Disability, notes the Deduction Type to have prorate applied.

  - `data.rX_BIN` (string)
    Information field used in custom client reporting.

  - `data.rX_CS_Contact` (string)
    Information field used in custom client reporting.

  - `data.rX_CS_Phone` (string)
    Information field used in custom client reporting.

  - `data.rX_GRP` (string)
    Information field used in custom client reporting.

  - `data.rX_Name` (string)
    Information field used in custom client reporting.

  - `data.rX_PCN` (string)
    Information field used in custom client reporting.

  - `data.reason_ID` (integer)
    No longer in use.

  - `data.region_Code` (string)
    Region Code for this group (locality).

  - `data.renewal_Completion_Date` (string)
    Information field used in custom client reporting.

  - `data.renewal_Date` (string)
    The last renewal date for this Group. Used in custom reporting. Not used in processing.

  - `data.self_Admin` (boolean, required)
    Notes if this group has Self-Admin billing. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.set_Billing_Due_Date` (boolean, required)
    Indicates if the system should calculate the Due Date on an invoice based on Billing_Due_Date settings. By default the due date is the "Bill Thru" on an invoice, this gives the option to change that calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.state` (string)
    State of the Group's address.

  - `data.subscriber_ID_Prefix` (string)
    The automatically applied Subscriber ID prefix when using auto generated IDs.

  - `data.subscriber_ID_Suffix` (string)
    The automatically applied Subscriber ID suffix when using auto generated IDs.

  - `data.total_Employees` (integer)
    Information field used in custom client reporting.

  - `data.uC_Percent` (string)
    Identifies the Usual and Customary percentage of the Group.

  - `data.update_Date` (string)
    Date when the record was last updated in the system.

  - `data.update_User` (string)
    User that last updated the record in the system.

  - `data.use_Employer_State` (boolean)
    Notes if Employe State, not Subscriber State, should be used in invoice generation. Note: The database will apply a default value of `False` for this field if a value is not provided.

  - `data.zip_Code` (string)
    Zip code of the Group's address.

  - `data.auto_Apply_Retro_Adj` (boolean)

  - `data.hide_Non_Applicable_Retro_Adj` (boolean)

  - `data.logo_File` (string)

  - `data.generate_PremDist_After` (string)

  - `error` (object)

  - `error.detail` (string)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 403:

  - `403` (unknown)
    Forbidden. The x-api-key header is missing or not valid. The API gateway sends this response, not VBAPI, so the body is not the VBAPI envelope; see Errors and troubleshooting.

## Response 429:

  - `429` (unknown)
    Too many requests. The limit is 25 requests per second sustained, with bursts up to 50, per API key. Wait and retry with exponential backoff and jitter.