# Query Workplaces

Endpoint: GET /companies/{companyId}/workplaces
Version: 1.0

## Path parameters:

  - `companyId` (string, required)

## Query parameters:

  - `id` (array, required)

  - `search` (string)

  - `active` (boolean)

  - `state` (array, required)
    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"

  - `includeId` (boolean)

  - `includeSearch` (boolean)

  - `includeState` (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.companyId` (string)

  - `results.name` (string,null)

  - `results.active` (boolean)

  - `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.timekeepingSettings` (object)

  - `results.timekeepingSettings.dailyOvertimeHoursStart` (number,null)

  - `results.timekeepingSettings.weeklyOvertimeHoursStart` (number,null)

  - `results.timekeepingSettings.dailyDoubleOvertimeHoursStart` (number,null)

  - `results.timekeepingSettings.weeklyDoubleOvertimeHoursStart` (number,null)

  - `results.timekeepingSettings.enablePaidMealBreaks` (boolean)

  - `results.timekeepingSettings.enablePaidRestBreaks` (boolean)

  - `results.timekeepingSettings.defaultTimeZoneId` (string,null)