> ## Documentation Index
> Fetch the complete documentation index at: https://docs.canary.effectiveai.app/llms.txt
> Use this file to discover all available pages before exploring further.

# List an employer’s sites

> List the workplaces matched to an employer, ordered by state, city and ID. Each site lists its identifiers: FEINs and OSHA establishment IDs, since OSHA can issue a new establishment ID for the same workplace. Read one with GET /insurance/employers/{employerId}/sites/{siteId}. Needs the OSHA dataset enabled for your organization. Read-only; private, no-store. 



## OpenAPI

````yaml /openapi.json get /insurance/employers/{employerId}/sites
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /insurance/employers/{employerId}/sites:
    get:
      tags:
        - OSHA
      summary: List an employer’s sites
      description: >-
        List the workplaces matched to an employer, ordered by state, city and
        ID. Each site lists its identifiers: FEINs and OSHA establishment IDs,
        since OSHA can issue a new establishment ID for the same workplace. Read
        one with GET /insurance/employers/{employerId}/sites/{siteId}. Needs the
        OSHA dataset enabled for your organization. Read-only; private,
        no-store. 
      operationId: listEmployerSites
      parameters:
        - schema:
            type: string
            pattern: ^emp_[0-9a-f]{20}$
            description: 'Effective employer ID: emp_ followed by 20 hex characters.'
          required: true
          description: 'Effective employer ID: emp_ followed by 20 hex characters.'
          name: employerId
          in: path
        - schema:
            type: string
            pattern: ^[A-Za-z]{2}$
            description: Two-letter state code, such as FL.
          required: false
          description: Two-letter state code, such as FL.
          name: state
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
            description: Maximum number of items to return (1-100).
          required: false
          description: Maximum number of items to return (1-100).
          name: limit
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 8192
            description: >-
              Opaque nextCursor from this operation. Repeat every other query
              parameter unchanged; a cursor from a different query returns
              invalid_cursor.
          required: false
          description: >-
            Opaque nextCursor from this operation. Repeat every other query
            parameter unchanged; a cursor from a different query returns
            invalid_cursor.
          name: cursor
          in: query
      responses:
        '200':
          description: One page of sites.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2EmployerSites'
        '400':
          description: >-
            invalid_request for invalid, unknown or repeated inputs;
            invalid_cursor means restart the list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            dataset_not_enabled: the OSHA dataset is not enabled for this
            organization. Other credential restrictions use forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: 'not_found: no such employer, site or OSHA row.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: A dependency is unavailable; respect Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2EmployerSites:
      type: object
      properties:
        sites:
          type: array
          items:
            $ref: '#/components/schemas/V2EmployerSite'
        nextCursor:
          type: string
          nullable: true
          description: Cursor for the next page, or null on the last page.
      required:
        - sites
        - nextCursor
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: >-
                Where to add the product to your account, for
                product_access_required.
          required:
            - code
    V2EmployerSite:
      type: object
      properties:
        id:
          type: string
          pattern: ^site_[0-9a-f]{20}$
          description: 'Effective site ID: site_ followed by 20 hex characters.'
        employerId:
          type: string
          pattern: ^emp_[0-9a-f]{20}$
          description: 'Effective employer ID: emp_ followed by 20 hex characters.'
        name:
          type: string
          description: Most recent name OSHA has on file at this site.
        address:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        state:
          type: string
          nullable: true
        zip:
          type: string
          nullable: true
          description: Five-digit ZIP code.
        naics:
          type: string
          nullable: true
        identifiers:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                  - fein
                  - osha_establishment
                description: >-
                  fein: FEIN from a Form 300A at this site. osha_establishment:
                  OSHA ITA establishment ID. OSHA can issue a new establishment
                  ID for the same workplace, so a site can carry several.
              value:
                type: string
            required:
              - type
              - value
        latestHeadcount:
          type: number
          nullable: true
          description: >-
            Annual average employees from the site’s latest Form 300A, or null
            if none.
        firstSeen:
          type: string
          nullable: true
          description: Earliest OSHA event date at this site.
        lastSeen:
          type: string
          nullable: true
          description: Latest OSHA event date at this site.
      required:
        - id
        - employerId
        - name
        - address
        - city
        - state
        - zip
        - naics
        - identifiers
        - latestHeadcount
        - firstSeen
        - lastSeen
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.