# Queries Companies

Endpoint: GET /companies
Version: 1.0

## Query parameters:

  - `id` (array, required)

  - `corporationId` (array, required)

  - `partnerId` (array, required)

  - `status` (string)
    Enum: "Active", "Fraud", "Closed", "Duplicate"

  - `search` (string)

  - `includeId` (boolean)

  - `includeCorporationId` (boolean)

  - `includePartnerId` (boolean)

  - `includeStatus` (boolean)

  - `includeSearch` (boolean)

  - `page` (integer)

  - `pageSize` (integer)

## Response 200 fields (application/json):

  - `hasResources` (boolean)

  - `totalResources` (integer)

  - `totalPages` (integer)

  - `pageSize` (integer)

  - `currentPage` (integer,null)

  - `previousPage` (integer,null)

  - `nextPage` (integer,null)

  - `results` (array,null)

  - `results.id` (string)

  - `results.legalName` (string,null)

  - `results.tradeName` (string,null)

  - `results.email` (string,null)

  - `results.phone` (string,null)

  - `results.website` (string,null)

  - `results.taxId` (string,null)

  - `results.timekeepingCode` (string,null)

  - `results.deactivationReason` (string,null)

  - `results.acceptedTerms` (boolean)

  - `results.legalType` (string)
    Enum: "SoleProprietorship", "LimitedLiabilityCompany", "Partnership", "NonProfitOrganization", "GovernmentOrganization", "CCorporation", "SCorporation"

  - `results.industry` (string)
    Enum: "GeneralConstructionGeneralContracting", "HvacPlumbingAndElectricalContracting", "FoodAndBeverageRetailAndWholesale", "ArtsEntertainmentAndRecreation", "ScientificAndTechnicalServices", "NonFoodRetailAndWholesale", "HospitalityAccommodation", "TobaccoOrAlcoholSales", "PersonalCareServices", "EducationalServices", "FamilyCareServices", "ConsultingServices", "AutoMachineRepair", "AutoMachineSales", "FinancialServices", "CleaningServices", "SecurityServices", "Transportation", "LegalServices", "HealthCare", "RealEstate", "Restaurant", "Other"

  - `results.status` (string)
    Enum: "Active", "Fraud", "Closed", "Duplicate"

  - `results.address` (object)

  - `results.address.street1` (string,null)

  - `results.address.street2` (string,null)

  - `results.address.city` (string,null)

  - `results.address.zipcode` (string,null)

  - `results.address.state` (string)
    Enum: "AL", "AK", "AR", "AZ", "CA", "CO", "CT", "DC", "DE", "FL", "GA", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MI", "MN", "MO", "MS", "MT", "NC", "ND", "NE", "NH", "NJ", "NM", "NV", "NY", "OK", "OH", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VA", "VT", "WA", "WI", "WV", "WY"

  - `results.address.country` (string)
    Enum: "US"

  - `results.created` (string)

  - `results.termsAcceptedAt` (string,null)

  - `results.payrollDetails` (object)

  - `results.payrollDetails.activated` (boolean)

  - `results.payrollDetails.canBoardPayroll` (boolean)

  - `results.payrollDetails.onboardingStartedAt` (string,null)

  - `results.payrollDetails.onboardingCompletedAt` (string,null)

  - `results.payrollDetails.completedItems` (array,null)
    Enum: "Initiated", "Enrollment", "PaymentSchedules", "Workplaces", "Departments", "Benefits", "Deductions", "Employees", "Contractors", "EarningCodes", "Historicals"

  - `results.payrollDetails.terminated` (boolean,null)

  - `results.payrollDetails.inGoodStanding` (boolean,null)

  - `results.payrollDetails.startDate` (string,null)

  - `results.payrollDetails.payFrequency` (string)
    Enum: "Weekly", "Biweekly", "Semimonthly", "Monthly", "Quarterly", "Annually"

  - `results.payrollDetails.processingPeriod` (string)
    Enum: "FourDay", "TwoDay", "OneDay", "ThreeDay"

  - `results.payrollDetails.employeeW2DeliveryMethod` (string)
    Enum: "PrintAndMailAll", "Manual"

  - `results.payrollDetails.contractor1099DeliveryMethod` (string)
    Enum: "PrintAndMailAll", "Manual"

  - `results.payrollDetails.onboardDetails` (object)

  - `results.payrollDetails.onboardDetails.blockingSteps` (array,null)

  - `results.payrollDetails.onboardDetails.remainingSteps` (array,null)

  - `results.payrollDetails.onboardDetails.bankAccount` (array,null)

  - `results.payrollDetails.onboardDetails.setupParameters` (array,null)

  - `results.payrollDetails.onboardDetails.setupParameters.name` (string,null)

  - `results.payrollDetails.onboardDetails.filingAuthorizations` (array,null)

  - `results.payrollDetails.implementationDetails` (object)

  - `results.merchantDetails` (object)

  - `results.merchantDetails.deliveryPolicyUrl` (string,null)

  - `results.merchantDetails.returnPolicyUrl` (string,null)

  - `results.merchantDetails.termsOfServiceUrl` (string,null)

  - `results.merchantDetails.canBoardMerchants` (boolean)

  - `results.merchantDetails.onboardingStatus` (string)
    Enum: "NotStarted", "Incomplete", "AwaitingApproval", "AwaitingActivation", "Completed"