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

# Get Contractor Template Review

> Reads the account-scoped contractor agreement redline review and its pending suggestions.

Required scope: `documents:read`

## OpenAPI

````yaml api-reference/openapi.json GET /hris/get-contractor-template-review
openapi: 3.1.0
info:
  title: Toku API
  version: 1.0.0
servers:
  - url: https://api.toku.com
security:
  - bearerAuth: []
paths:
  /hris/get-contractor-template-review:
    get:
      operationId: getContractorTemplateReview
      summary: Get Contractor Template Review
      x-toku-required-scope: documents:read
      description: >-
        Reads the account-scoped contractor agreement redline review and its
        pending suggestions.


        Required scope: `documents:read`
      parameters:
        - name: orgId
          in: query
          required: true
          schema:
            type: string
            format: uuid
        - name: reviewKey
          in: query
          required: false
          description: '"contractor" (the default) or "employment:<template id>".'
          schema:
            type: string
            pattern: >-
              ^(contractor|employment:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
            description: '"contractor" (the default) or "employment:<template id>".'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetContractorTemplateReviewResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Conflict
        '429':
          description: Response 429
components:
  schemas:
    GetContractorTemplateReviewResponse:
      type: object
      properties:
        canReview:
          type: boolean
        orgName:
          type: string
        templates:
          type: array
          items:
            $ref: '#/components/schemas/ContractorReviewTemplate'
        review:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              format: uuid
            reviewKey:
              type: string
            revision:
              type: integer
            status:
              type: string
            data: {}
            events:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  revision:
                    type: integer
                  action:
                    type: string
                  createdAt:
                    type: string
                    format: date-time
                  data: {}
                  notificationPending:
                    type: boolean
      description: Request regeneration does not infer response shapes.
    ContractorReviewTemplate:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        activeName:
          type: string
        kind:
          type: string
          enum:
            - CONTRACTOR
            - EMPLOYMENT
          description: >-
            CONTRACTOR templates share one review; each EMPLOYMENT (EOR)
            template has its own.
        reviewKey:
          type: string
        countryCodes:
          type: array
          items:
            type: string
        reviewStatus:
          type:
            - string
            - 'null'
        reviewRevision:
          type: integer
        customized:
          type: boolean
        version:
          type:
            - integer
            - 'null'
        available:
          type: boolean
        updatedAt:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
````
