openapi.yaml

openapi: 3.0.3
info:
  title: API Settings
  description: >-
    We specialize in sourcing high quality pilots to meet the needs of 135
    operators. Our team of highly skilled pilots and aviation experts seamlessly
    integrates with your operation to quickly provide you with world-class pilot
    candidates from our extensive network. All candidates are fully vetted and
    evaluated by Hire Up prior to being recommended to you.
  version: '3'
servers:
  - url: https://api.breezy.hr
tags:
  - name: Company
  - name: Questionnaire
  - name: User
  - name: Conversation
  - name: CustomField
  - name: Authentication
  - name: Session
  - name: BackgroundCheck
  - name: CustomAttribute
  - name: WorkHistory
paths:
  /v3/signin:
    post:
      tags:
        - Authentication
      summary: /signin
      operationId: Authentication_getAccessToken
      description: >-
        Retrieve an access token. Use the access_token as part of the
        Authorization header.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationGetAccessTokenRequest'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "access_token": "00000000-0000-0000-0000-000000000000",
                        "user": { User }
                    }
              schema:
                $ref: '#/components/schemas/AuthenticationGetAccessTokenResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Email Address:
                  value: |-
                    {
                        "error": {
                            "type": "signinEmailError",
                            "message": "email is null or empty"
                        }
                    }
                Missing Password:
                  value: |-
                    {
                        "error": {
                            "type": "signinPasswordError",
                            "message": "password is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/AuthenticationGetAccessToken400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Signin Failure:
                  value: |-
                    {
                        "error": {
                            "type": "signinFailure",
                            "message": "email or password incorrect."
                        }
                    }
              schema:
                $ref: '#/components/schemas/AuthenticationGetAccessToken401Response'
        '500':
          description: '500'
          content:
            text/plain:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "accessTokenCreationError",
                            "message": "There was an error creating Access Token."
                        }
                    }
              schema:
                $ref: '#/components/schemas/AuthenticationGetAccessToken500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: |-
              curl -H "Content-Type: application/json" \
                -X POST \
                -d '{"email":"user@emailaddress.com","password":"hunter2"}' \
                https://api.breezy.hr/v3/signin
        samples-languages:
          - curl
  /v3/signout:
    get:
      tags:
        - Session
      summary: /signout
      operationId: Session_invalidateToken
      description: This endpoint invalidates an access token.
      responses:
        '204':
          description: '204'
          content:
            application/json:
              examples:
                Result:
                  value: ''
              schema:
                $ref: '#/components/schemas/SessionInvalidateTokenResponse'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/signout
        samples-languages:
          - curl
  /v3/user:
    get:
      tags:
        - User
      summary: /user
      operationId: User_getById
      description: Retrieve the authenticated user or another user by id
      parameters:
        - description: user id to lookup (if blank look up by auth token)
          name: user_id
          in: query
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{ User }'
              schema:
                $ref: '#/components/schemas/UserGetByIdResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/UserGetById400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/UserGetById401Response'
        '404':
          description: '404'
          content:
            application/json:
              examples:
                User Not Found:
                  value: |-
                    {
                        "error": {
                            "type": "userNotFound",
                            "message": "user not found."
                        }
                    }
              schema:
                $ref: '#/components/schemas/UserGetById404Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getUserError",
                            "message": "there was an unknown error getting user."
                        }
                    }
              schema:
                $ref: '#/components/schemas/UserGetById500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/user
        samples-languages:
          - curl
  /v3/user/details:
    get:
      tags:
        - User
      summary: /user/details
      operationId: User_getCompanyDetails
      description: >-
        Retrieve the details for the configurations of each company the
        authenticated user belongs to.
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[ \n\t\"<company_id>\": {\n\t\t\"company\": { Company },\n    \"messaging\": {\n\t\t\t\"questionnaire_template\": {\n        \"type\": String,\n        \"body\": String\n\t\t\t},\n      \"subject_template\": {\n        \"type\": String\n        \"body\": String\n      }\n\t\t},\n    \"reasons\": {\n    \t\"disposition\": [\n        {\n          \"name\": String,\n          \"_id\": String\n        }, . . .               \n      ],\n    \t\"creation_date\": Date,\n    \t\"updated_date\": Date\n    },\n    \"questionnaires\": [           \n    \t{ Questionnaire },\n      ...            \n    ],\n    \"pipelines\": {\n      \"<pipeline_id>\": { Pipeline },\n      ...           \n    },\n    \"interview_guides\": [\n      { Interview Guide },\n      ...\n    ],\n    \"templates\": [\n      { Template },\n      ...        \n    ],\n    \"tasks\": [\n      { Task },\n      ...        \n    ],\n    \"scorecards\": [\n      { Scorecard },\n      ... \n    ],\n    \"user_settings\": {\n      \"webcal_uri\": String \n    },\n    \"positions\": {\n      \"<position_id>\": { Position },\n      ...\n    },\n    \"members\": [\n      { User },\n      ...\n    ]\n  },\n\t...\n]"
              schema:
                $ref: '#/components/schemas/UserGetCompanyDetailsResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/UserGetCompanyDetails400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/UserGetCompanyDetails401Response'
        '404':
          description: '404'
          content:
            application/json:
              examples:
                User Not Found:
                  value: |-
                    {
                        "error": {
                            "type": "userNotFound",
                            "message": "user not found."
                        }
                    }
              schema:
                $ref: '#/components/schemas/UserGetCompanyDetails404Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getUserCompaniesDetailError",
                            "message": "there was an unknown error getting user company details."
                        }
                    }
              schema:
                $ref: '#/components/schemas/UserGetCompanyDetails500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/user/details
        samples-languages:
          - curl
  /v3/company/{company_id}:
    get:
      tags:
        - Company
      summary: /company/:id/
      operationId: Company_getInformation
      description: >-
        Retrieve the company information associated with authenticated user and
        company id
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    { 
                      Company Object
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetInformationResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetInformation400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetInformation401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getCompanyError",
                            "message": "there was an unknown error getting company."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetInformation500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000
        samples-languages:
          - curl
  /v3/company/{company_id}/custom-attributes/candidate:
    get:
      tags:
        - Company
      summary: /company/:id/custom-attributes/candidate
      operationId: Company_getCandidateCustomAttributes
      description: Retrieve all of the candidate specific custom attributes
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n  {\n  \t\"id\": String,\n\t\t\"name\": String,\n\t\t\"secure\": Boolean\n  },\n  ...\n],"
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetCandidateCustomAttributesResponse
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetCandidateCustomAttributes400Response
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetCandidateCustomAttributes401Response
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getCustomAttributesError",
                            "message": "there was an unknown error getting custom attributes."
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetCandidateCustomAttributes500Response
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/custom-attributes/candidate
        samples-languages:
          - curl
  /v3/company/{company_id}/custom-attributes/position:
    get:
      tags:
        - Company
      summary: /company/:id/custom-attributes/position
      operationId: Company_getPositionCustomAttributes
      description: Retrieve all of the position specific custom attributes
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n  {\n  \t\"id\": String,\n\t\t\"name\": String,\n\t\t\"secure\": Boolean\n  },\n  ...\n],"
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPositionCustomAttributesResponse
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPositionCustomAttributes400Response
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPositionCustomAttributes401Response
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getCustomAttributesError",
                            "message": "there was an unknown error getting custom attributes."
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPositionCustomAttributes500Response
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/custom-attributes/position
        samples-languages:
          - curl
  /v3/company/{company_id}/pipeline/{pipeline_id}:
    get:
      tags:
        - Company
      summary: /company/:id/pipeline/:id
      operationId: Company_getPipelineStagesByPipelineId
      description: Retrieve pipeline stages by pipeline id
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
        - description: pipeline id
          name: pipeline_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    [ // all stages on pipeline
                      {
                        "id": "applied",
                        "name": "Applied",
                        "icon": "user",
                        "action_count": 0,
                        "actions": {},
                        "type": "type",
                        "action": "action"
                      } . . .
                    ]
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPipelineStagesByPipelineIdResponse
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPipelineStagesByPipelineId400Response
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPipelineStagesByPipelineId401Response
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getPipelineError",
                            "message": "there was an unknown error getting pipeline."
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPipelineStagesByPipelineId500Response
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/pipeline/000000000000
        samples-languages:
          - curl
  /v3/company/{company_id}/pipelines:
    get:
      tags:
        - Company
      summary: /company/:id/pipelines
      operationId: Company_getPipelines
      description: Retrieve all of the company pipelines
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n\t\"<pipeline_id>\": {\n    Pipeline Object\n  },\n  ...\n]"
              schema:
                $ref: '#/components/schemas/CompanyGetPipelinesResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPipelines400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPipelines401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getPipelinesError",
                            "message": "there was an unknown error getting pipelines."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPipelines500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/pipelines
        samples-languages:
          - curl
  /v3/company/{company_id}/questionnaire/{questionnaire_id}:
    get:
      tags:
        - Company
      summary: /company/:id/questionnaire/:id
      operationId: Company_getQuestionnaireById
      description: Retrieve questionnaire by id
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: questionnaire_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    { 
                      Questionnaire Object
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetQuestionnaireByIdResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetQuestionnaireById400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetQuestionnaireById401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getTemplateError",
                            "message": "there was an unknown error getting questionnaire."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetQuestionnaireById500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/questionnaire/000000000000
        samples-languages:
          - curl
  /v3/company/{company_id}/questionnaires:
    get:
      tags:
        - Company
      summary: /company/:id/questionnaires
      operationId: Company_getQuestionnaires
      description: Retrieve all of the company questionnaires
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    [
                      { Questionnaire Object },
                      ...
                    ],
              schema:
                $ref: '#/components/schemas/CompanyGetQuestionnairesResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetQuestionnaires400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetQuestionnaires401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getTemplateError",
                            "message": "there was an unknown error getting questionnaires."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetQuestionnaires500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/questionnaires
        samples-languages:
          - curl
  /v3/company/{company_id}/template/{template_id}:
    get:
      tags:
        - Company
      summary: /company/:id/template/:id
      operationId: Company_getEmailTemplateById
      description: Retrieve email template by id
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
        - description: template id
          name: template_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    { 
                      Template Object
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetEmailTemplateByIdResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetEmailTemplateById400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetEmailTemplateById401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getTemplateError",
                            "message": "there was an unknown error getting template."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetEmailTemplateById500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/template/000000000000
        samples-languages:
          - curl
  /v3/company/{company_id}/templates:
    get:
      tags:
        - Company
      summary: /company/:id/templates
      operationId: Company_getAllTemplates
      description: Retrieve all of the company email templates
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    [
                      { Template Object },
                      ...
                    ],
              schema:
                $ref: '#/components/schemas/CompanyGetAllTemplatesResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetAllTemplates400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetAllTemplates401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getTemplateError",
                            "message": "there was an unknown error getting template."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetAllTemplates500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/templates
        samples-languages:
          - curl
  /v3/companies:
    get:
      tags:
        - Company
      summary: /companies
      operationId: Company_getAssociated
      description: Retrieve the companies associated with the authenticated user
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n\t{ Company Object},\n  ...\n]"
              schema:
                $ref: '#/components/schemas/CompanyGetAssociatedResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetAssociated400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetAssociated401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getCompaniesError",
                            "message": "there was an unknown error getting companies."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetAssociated500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/companies
        samples-languages:
          - curl
  /v3/company/{company_id}/position/{position_id}:
    get:
      tags:
        - Company
      summary: ./position/:id
      operationId: Company_getPositionDetails
      description: Retrieve details for given position id
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
        - description: position id
          name: position_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    { 
                      Position Object      
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionDetailsResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionDetails400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionDetails401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getPositionError",
                            "message": "there was an unknown error getting position."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionDetails500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000
        samples-languages:
          - curl
    put:
      tags:
        - Company
      summary: ./position/:id
      operationId: Company_updatePositionDetails
      description: Update details for given position
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyUpdatePositionDetailsRequest'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                       Position Object
                    }
              schema:
                $ref: '#/components/schemas/CompanyUpdatePositionDetailsResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
                Missing Required Field:
                  value: |-
                    {
                        "error": {
                            "type": "addPosition<Field>Missing",
                            "message": "<field> is null or empty"
                        }
                    }
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "addPositionFieldInvalid",
                            "message": "<field>  must be one of the following values: <values>"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUpdatePositionDetails400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUpdatePositionDetails401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "updatePositionError",
                            "message": "there was an unknown error updating position."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUpdatePositionDetails500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: http
            code: "PUT /v3/company/000000000000/position/000000000000 HTTP/1.1\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n  \"name\": \"New Job\",\n  \"type\": \"fullTime\",\n  \"description\": \"This is the job description\",\n  \"location\": {\n\t\t\"country\": \"US\",\n\t\t\"state\": \"FL\",\n\t\t\"city\": \"Jacksonville\",\n\t\t\"is_remote\": false\n  },\n  \"education\":\"high-school\",\n  \"category\": \"sysadmin\",\n  \"experience\": \"internship\",\n  \"custom_attributes\": [\n  \t{\n    \t\"name\": \"Max Salary\",\n      \"value\": \"1000000\",\n      \"secure\": true\n    }\n  ],\n  \"pipeline_id\": \"000000000000\", \n  \"scorecard_id\": \"000000000000\", \n  \"questionnaire_id\": \"000000000000\",\n  \"tags\": [\"technical\", \"junior\"]\n}"
          - language: curl
            code: >+
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X PUT -d '{ "name": "New
              Job", "type": "fullTime", "description": "This is the job
              description", "location": { "country": "US", "state": "FL",
              "city": "Jacksonville", "is_remote": false },
              "education":"high-school", "category": "sysadmin", "experience":
              "internship","custom_attributes": [ { "name": "Max Salary",
              "value": "1000000", "secure": true }], "pipeline_id":
              "000000000000", "scorecard_id": "000000000000",
              "questionnaire_id": "000000000000","tags": ["technical", "junior"]
              }'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000

        samples-languages:
          - http
          - curl
  /v3/company/{company_id}/position/{position_id}/state:
    put:
      tags:
        - Company
      summary: ./position/:id/state
      operationId: Company_updatePositionState
      description: Update details for given position
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyUpdatePositionStateRequest'
      responses:
        '204':
          description: '204'
          content:
            application/json:
              examples:
                Result:
                  value: ''
              schema:
                $ref: '#/components/schemas/CompanyUpdatePositionStateResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
                Missing Required Field:
                  value: |-
                    {
                        "error": {
                            "type": "addPosition<Field>Missing",
                            "message": "<field> is null or empty"
                        }
                    }
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "addPositionFieldInvalid",
                            "message": "<field>  must be one of the following values: <values>"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUpdatePositionState400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUpdatePositionState401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "updatePositionError",
                            "message": "there was an unknown error updating position."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUpdatePositionState500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: http
            code: |-
              PUT /v3/company/000000000000/position/000000000000/state HTTP/1.1
              Host: api.breezy.hr
              Authorization: 00000000-0000-0000-0000-000000000000
              Content-Type: application/json

              {
                "state": "closed"  
              }
          - language: curl
            code: >+
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X PUT -d '{ "state":
              "closed" }'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/state

        samples-languages:
          - http
          - curl
  /v3/company/{company_id}/position/{position_id}/stream:
    get:
      tags:
        - Company
      summary: ./position/:id/stream
      operationId: Company_getPositionStream
      description: Retrieve the last 30 activity stream events for the given position
      parameters:
        - description: company
          name: company_id
          in: path
          required: true
          schema:
            type: string
        - description: position id
          name: position_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    [
                      {
                        "_id": String,            
                        "type": String,
                        "stream_id": String,
                        "object": {}, //the notification object specific to the notificationType above
                        "timestamp": Date
                      },
                      ...
                    ]
              schema:
                $ref: '#/components/schemas/CompanyGetPositionStreamResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                      "error": "No access token found"
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionStream400Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/stream
        samples-languages:
          - curl
  /v3/company/{company_id}/position/{position_id}/team:
    get:
      tags:
        - Company
      summary: ./position/:id/team
      operationId: Company_getPositionTeamMembers
      description: Retrieve user objects of all position team members
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
        - description: position id
          name: position_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n   {\n      \"_id\": String,\n      \"email_address\": String,\n      \"name\": String,\n      \"username\": String,\n      \"initial\": Char(1),\n      \"creation_date\": Date,\n      \"verified_email\": Boolean,\n      \"tz_offset\": String,\n      \"signature\": {\n        \"enabled\": Boolean,\n        \"body\": String\n      },\n      \"updated_date\": Date,\n      \"user_role\": {\n\t\t\t\t\"id\": \"member | hiring_manager\",\n\t\t\t\t\"name\": \"Hiring Team Member | Hiring Manager\"\n\t\t\t}\n   }\n]"
              schema:
                $ref: '#/components/schemas/CompanyGetPositionTeamMembersResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionTeamMembers400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionTeamMembers401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getPositionTeamError",
                            "message": "there was an unknown error getting position team."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionTeamMembers500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/team
        samples-languages:
          - curl
  /v3/company/{company_id}/positions:
    get:
      tags:
        - Company
      summary: ./positions
      operationId: Company_getPositionsByState
      description: Retrieve all positions for given company in given state (status)
      parameters:
        - description: >-
            Specify an optional position state filter. e.g. draft, archived,
            published, closed, pending
          name: state
          in: query
          schema:
            type: string
            default: published
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n\t{ Position Object },\n  ...\n]"
              schema:
                $ref: '#/components/schemas/CompanyGetPositionsByStateResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionsByState400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionsByState401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getPositionsError",
                            "message": "there was an unknown error getting positions."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionsByState500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/positions?state=published
        samples-languages:
          - curl
    post:
      tags:
        - Company
      summary: ./positions
      operationId: Company_createNewPosition
      description: Create a new position
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyCreateNewPositionRequest'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                       Position Object
                    }
              schema:
                $ref: '#/components/schemas/CompanyCreateNewPositionResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
                Missing Required Field:
                  value: |-
                    {
                        "error": {
                            "type": "addPosition<Field>Missing",
                            "message": "<field> is null or empty"
                        }
                    }
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "addPositionFieldInvalid",
                            "message": "<field>  must be one of the following values: <values>"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyCreateNewPosition400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyCreateNewPosition401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "addPositionError",
                            "message": "there was an unknown error creating position."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyCreateNewPosition500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: http
            code: "POST /v3/company/000000000000/positions HTTP/1.1\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n  \"name\": \"New Job\",\n  \"type\": \"fullTime\",\n  \"description\": \"This is the job description\",\n  \"location\": {\n\t\t\"country\": \"US\",\n\t\t\"state\": \"FL\",\n\t\t\"city\": \"Jacksonville\",\n\t\t\"is_remote\": false\n  },\n  \"education\":\"high-school\",\n  \"category\": \"sysadmin\",\n  \"experience\": \"internship\",\n  \"custom_attributes\": [\n  \t{\n    \t\"name\": \"Max Salary\",\n      \"value\": \"1000000\",\n      \"secure\": true\n    }\n  ],\n  \"pipeline_id\": \"000000000000\",\n  \"scorecard_id\": \"000000000000\",\n  \"questionnaire_id\": \"000000000000\",\n  \"tags\": [\"technical\", \"junior\"]\n}"
          - language: curl
            code: >+
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X POST -d '{ "name": "New
              Job", "type": "fullTime", "description": "This is the job
              description", "location": { "country": "US", "state": "FL",
              "city": "Jacksonville", "is_remote": false },
              "education":"high-school", "category": "sysadmin", "experience":
              "internship","custom_attributes": [ { "name": "Max Salary",
              "value": "1000000", "secure": true }], "pipeline_id":
              "000000000000", "scorecard_id": "000000000000",
              "questionnaire_id": "000000000000", "tags": ["technical",
              "junior"] }'
              https://api.breezy.hr/v3/company/000000000000/positions

        samples-languages:
          - http
          - curl
  /v3/company/{company_id}/position/{position_id}/custom-fields:
    get:
      tags:
        - Company
      summary: ./position/:id/custom-fields
      operationId: Company_getPositionCustomFields
      description: ''
      parameters:
        - description: company id
          name: company_id
          in: path
          schema:
            type: string
          required: true
        - description: position id
          name: position_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n\tPosition Custom Field Object\n]"
              schema:
                $ref: '#/components/schemas/CompanyGetPositionCustomFieldsResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionCustomFields400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionCustomFields401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getPositionCustomFieldsError",
                            "message": "there was an unknown error getting position custom fields."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionCustomFields500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/custom-fields
        samples-languages:
          - curl
  /v3/company/{company_id}/position/{position_id}/custom-fields/{custom_field_id}:
    put:
      tags:
        - Company
      summary: ./position/:id/custom-fields/:id
      operationId: Company_updateCustomField
      description: ''
      parameters:
        - description: company id
          name: company_id
          in: path
          schema:
            type: string
          required: true
        - description: position id
          name: position_id
          in: path
          schema:
            type: string
          required: true
        - description: custom field id
          name: custom_field_id
          in: path
          schema:
            type: string
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyUpdateCustomFieldRequest'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n\tPosition Custom Field Object\n]"
              schema:
                $ref: '#/components/schemas/CompanyUpdateCustomFieldResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUpdateCustomField400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUpdateCustomField401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "updatePositionCustomFieldsError",
                            "message": "there was an unknown error updating position fields."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUpdateCustomField500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: http
            code: "PUT /v3/company/000000000000/position/000000000000/custom-fields/000000000000\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n\t\"value\": \"new value\"\n}"
          - language: curl
            code: >
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X PUT -d '{ "value": "new
              value"}'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/custom-fields/000000000000
        samples-languages:
          - http
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}:
    get:
      tags:
        - Company
      summary: ./candidate/:id
      operationId: Company_getCandidateById
      description: Retrieve candidate by id for given position
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
        - description: position id
          name: position_id
          in: path
          required: true
          schema:
            type: string
        - description: candidate id
          name: candidate_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n\tCandidate Object\n}"
              schema:
                $ref: '#/components/schemas/CompanyGetCandidateByIdResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetCandidateById400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetCandidateById401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getCandidateErrror",
                            "message": "there was an unknown error getting candidate."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetCandidateById500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000
        samples-languages:
          - curl
    put:
      tags:
        - Company
      summary: ./candidate/:id
      operationId: Company_updateCandidatePosition
      description: Updates a candidate on a position
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyUpdateCandidatePositionRequest'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                       Candidate Object
                    }
              schema:
                $ref: '#/components/schemas/CompanyUpdateCandidatePositionResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUpdateCandidatePosition400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUpdateCandidatePosition401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "updateCandidateError",
                            "message": "there was an unknown error updating candidate."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUpdateCandidatePosition500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: http
            code: "PUT /v3/company/000000000000/position/000000000000/candidate/000000000000 HTTP/1.1\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n  \"name\": \"New Candidate\",\n  \"email_address\": \"candidate@emailaddress.com\",\n  \"phone_number\": \"123-456-7890\",\n  \"summary\": \"I will be a good candidate for any job you have!\",\n  \"tags\": [\"technical\", \"junior\"],\n  \"source\": \"LinkedIn\",\n  \"headline\": \"This is the candidate headline\",\n  \"address\": \"1234 Mockingbird Lane\\nTopeka, KS 12345\",\n  \"social_profiles\": {\n  \t\"facebook\": \"https://link.to/facebook\",\n    \"github\": \"https://link.to/github\"\n  },\n  \"cover_letter\": \"Please consider me\"\n}"
          - language: curl
            code: >+
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X PUT -d '{ "name": "New
              Candidate", "email_address": "candidate@emailaddress.com",
              "phone_number": "123-456-7890", "summary": "I will be a good
              candidate for any job you have!", "tags": ["technical", "junior"],
              "source": "LinkedIn", "headline": "This is the candidate
              headline", "address": "1234 Mockingbird Lane\nTopeka, KS 12345",
              "social_profiles": { "facebook": "https://link.to/facebook",
              "github": "https://link.to/github" }, "cover_letter": "Please
              consider me"}'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000

        samples-languages:
          - http
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/assessments:
    get:
      tags:
        - Company
      summary: ./candidate/:id/assessments
      operationId: Company_getAssessments
      description: Retrieve all 3rd party assessments candidate has taken
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
        - description: position id
          name: position_id
          in: path
          required: true
          schema:
            type: string
        - description: candidate id
          name: candidate_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n\tAssessment Object\n}"
              schema:
                $ref: '#/components/schemas/CompanyGetAssessmentsResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetAssessments400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetAssessments401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getCandidateAssessmentsErrror",
                            "message": "there was an unknown error getting candidate assessments"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetAssessments500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/assessments
        samples-languages:
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/background-checks:
    get:
      tags:
        - BackgroundCheck
      summary: ./candidate/:id/background-checks
      operationId: BackgroundCheck_getAll
      description: Retrieve all 3rd party background checks for candidate
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
        - description: position id
          name: position_id
          in: path
          required: true
          schema:
            type: string
        - description: candidate id
          name: candidate_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n\tBackground Check Object\n}"
              schema:
                $ref: '#/components/schemas/BackgroundCheckGetAllResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/BackgroundCheckGetAll400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/BackgroundCheckGetAll401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getCandidateAssessmentsErrror",
                            "message": "there was an unknown error getting candidate background checks"
                        }
                    }
              schema:
                $ref: '#/components/schemas/BackgroundCheckGetAll500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/background-checks
        samples-languages:
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/conversation:
    get:
      tags:
        - Conversation
      summary: ./candidate/:id/conversation
      operationId: Conversation_getStream
      description: Retrieve candidate conversation stream
      parameters:
        - description: company _id
          name: company_id
          in: path
          required: true
          schema:
            type: string
        - description: position id
          name: position_id
          in: path
          required: true
          schema:
            type: string
        - description: candidate id
          name: candidate_id
          in: path
          required: true
          schema:
            type: string
        - description: >-
            1 to include any messages that are currently queued for delayed
            delivery
          name: include_delayed
          in: query
          schema:
            type: integer
            format: int32
            default: 0
        - description: Number of records to skip for paging
          name: skip
          in: query
          schema:
            type: integer
            format: int32
            default: 0
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n  {\n    \"_id\": String,\n    \"type\": \"messageToCandidatePosted | messageFromCandidatePosted\",\n    \"object\": {\n      \"body\": String,\n      \"subject\": Subject,\n      \"attachments\": [\n        {\n      \t\t\"status\": String,\n        \t\"file_name\": String,\n        \t\"url\": String,\n        \t\"content_type\": String\n        },\n        ...\n      ],      \n      \"candidate_id\": String,\n      \"company_id\": String,\n      \"position_id\": String,\n      \"acting_user\": { Candidate | User}\n    },\n    \"timestamp\": Date\n  }\n]"
              schema:
                $ref: '#/components/schemas/ConversationGetStreamResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/ConversationGetStream400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/ConversationGetStream401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getConversationError",
                            "message": "there was an unknown error getting candidate conversation."
                        }
                    }
              schema:
                $ref: '#/components/schemas/ConversationGetStream500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/conversation?include_delayed=1&skip=50
        samples-languages:
          - curl
    post:
      tags:
        - Conversation
      summary: ./candidate/:id/conversation
      operationId: Conversation_addMessage
      description: Adds a new conversation message for the candidate
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConversationAddMessageRequest'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"_id\": String,\n  \"type\": \"messageToCandidatePosted\",\n  \"object\": {\n    \"body\": String,\n    \"subject\": Subject,\n    \"attachments\": [\n      {\n        \"status\": String,\n        \"file_name\": String,\n        \"url\": String,\n        \"content_type\": String\n      },\n      ...\n    ],      \n\t\t\"candidate_id\": String,\n\t\t\"company_id\": String,\n\t\t\"position_id\": String,\n\t\t\"acting_user\": { Candidate | User}\n\t},\n\t\"timestamp\": Date\n}"
              schema:
                $ref: '#/components/schemas/ConversationAddMessageResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "postConversationMissingBody",
                            "message": "body is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/ConversationAddMessage400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/ConversationAddMessage401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "postMessageError",
                            "message": "there was an unknown error posting message."
                        }
                    }
              schema:
                $ref: '#/components/schemas/ConversationAddMessage500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: html
            code: >-
              POST
              /v3/company/000000000000/position/000000000000/candidate/000000000000/conversation
              HTTP/1.1

              Host: api.breezy.hr

              Authorization: 00000000-0000-0000-0000-000000000000

              Content-Type: application/json


              {
                "body": "Hi there! This is a test message!"
              }
          - language: curl
            code: >+
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X POST -d '{ "body": "Hi
              there! This is a test message!" }'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/conversation

        samples-languages:
          - html
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/custom-attribute:
    put:
      tags:
        - CustomAttribute
      summary: ./candidate/:id/custom-attribute
      operationId: CustomAttribute_addToCandidateCustomAttribute
      description: Adds a custom-attribute to a candidate
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/CustomAttributeAddToCandidateCustomAttributeRequest
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                       Candidate Object
                    }
              schema:
                $ref: >-
                  #/components/schemas/CustomAttributeAddToCandidateCustomAttributeResponse
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CustomAttributeAddToCandidateCustomAttribute400Response
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CustomAttributeAddToCandidateCustomAttribute401Response
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "updateCandidateError",
                            "message": "there was an unknown error updating candidate."
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CustomAttributeAddToCandidateCustomAttribute500Response
      deprecated: false
      x-readme:
        code-samples:
          - language: http
            code: "PUT /v3/company/000000000000/position/000000000000/candidate/000000000000/custom-attribute HTTP/1.1\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n\t\"name\": \"Desired Salary\",\n\t\"value\": \"100000\"\n\t\"secure\": true\n}"
          - language: curl
            code: >+
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X PUT -d '{"name": "Desired
              Salary","value": "100000""secure": true}'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/custom-attribute

        samples-languages:
          - http
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/documents:
    get:
      tags:
        - Company
      summary: ./candidate/:id/documents
      operationId: Company_getCandidateDocumentsByPosition
      description: Retrieve candidate documents by id for given position
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n\t{\n\t\t\"_id\": String,\n\t\t\"company_id\": String,\n\t\t\"position_id\": String,        \n\t\t\"candidate_id\": String,\n\t\t\"acting_user\": { User | Candidate},\n\t\t\"file_name\": String,\n\t\t\"file_url\": String,\n\t\t\"file_size\": Integer,\n\t\t\"creation_date\": Date\n\t},\n  ...\n]"
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetCandidateDocumentsByPositionResponse
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetCandidateDocumentsByPosition400Response
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetCandidateDocumentsByPosition401Response
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getDocumentsError",
                            "message": "there was an unknown error getting documents."
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetCandidateDocumentsByPosition500Response
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/documents
        samples-languages:
          - curl
    post:
      tags:
        - Company
      summary: ./candidate/:id/documents
      operationId: Company_addCandidateDocument
      description: Adds a new document for the candidate
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                      "_id": String,
                      "company_id": String,
                      "position_id": String,        
                      "candidate_id": String,
                      "acting_user": { User },
                      "file_name": String,
                      "file_url": String,
                      "file_size": Integer,
                      "creation_date": Date
                    }
              schema:
                $ref: '#/components/schemas/CompanyAddCandidateDocumentResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyAddCandidateDocument400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyAddCandidateDocument401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "addDocumentError",
                            "message": "there was an unknown error saving document."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyAddCandidateDocument500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -X POST -H "Authorization:
              00000000-0000-0000-0000-000000000000" -F'data=@/path/to/file'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/documents
        samples-languages:
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/education:
    put:
      tags:
        - Company
      summary: ./candidate/:id/education
      operationId: Company_addEducationEntry
      description: Adds an education entry to a candidate
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyAddEducationEntryRequest'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                       Candidate Object
                    }
              schema:
                $ref: '#/components/schemas/CompanyAddEducationEntryResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyAddEducationEntry400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyAddEducationEntry401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "updateCandidateError",
                            "message": "there was an unknown error updating candidate."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyAddEducationEntry500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: http
            code: "PUT /v3/company/000000000000/position/000000000000/candidate/000000000000/education HTTP/1.1\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n\t\"school_name\": \"Widget School\",\n\t\"field_of_study\": \"Widget Making\",\n\t\"start_year\": 2017,\n\t\"end_year\": 11\n}"
          - language: curl
            code: >+
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X PUT -d '{"school_name":
              "Widget School","field_of_study": "Widget Making","start_year":
              2017,"end_year": 11}'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/education

        samples-languages:
          - http
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/meta:
    get:
      tags:
        - Company
      summary: ./candidate/:id/meta
      operationId: Company_getPositionCandidateMeta
      description: Retrieve candidate meta data by id for given position
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"tasks\": [], //any tasks for this candidate,\n  \"background_checks\": [], //any background check information\n  \"notepad\": [], //authenticated user's notes\n  \"team_notepad\": [], //team notes user has access to see\n  \"assessments\": [], //any external assessment information\n  \"stream\": [], //discussion stream\n  \"schedule\": [], //any scheduled meetings with candidate\n \t\"documents\": [], //any documents attached to candidate\n  \"questionnaires\": [], //any questionnaires sent to the candidate\n  \"conversation\": [], //email conversation thread\n  \"references\": [], //any references added to candidate\n  \"scorecards\": [] //any scorecards filled out for candidate\n}"
              schema:
                $ref: '#/components/schemas/CompanyGetPositionCandidateMetaResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPositionCandidateMeta400Response
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPositionCandidateMeta401Response
        '500':
          description: '500'
          content:
            text/plain:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getCandidateMetadataError",
                            "message": "there was an unknown error getting candidate metadata."
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPositionCandidateMeta500Response
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/meta
        samples-languages:
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/move:
    post:
      tags:
        - Company
      summary: ./candidate/:id/move
      operationId: Company_moveCandidateToPosition
      description: Moves a candidate from one position to another
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyMoveCandidateToPositionRequest'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{ Candidate Object }'
              schema:
                $ref: '#/components/schemas/CompanyMoveCandidateToPositionResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "moveCandidateMissingPosition",
                            "message": "target_position_id is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyMoveCandidateToPosition400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "moveCandidateUserNotAuthorized",
                            "message": "user does not have proper access to target position"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyMoveCandidateToPosition401Response'
        '404':
          description: '404'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "moveCandidatePositionNotFound",
                            "message": "target position not found"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyMoveCandidateToPosition404Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "postMessageError",
                            "message": "there was an unknown error posting message."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyMoveCandidateToPosition500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: html
            code: "POST /v3/company/000000000000/position/000000000000/candidate/000000000000/move HTTP/1.1\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n\t\"target_position_id\": \"000000000000\",\n\t\"target_stage_id\": \"applied\",\n  \"stage_actions_enabled\": false\n}"
          - language: curl
            code: >+
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X POST -d
              '{"target_position_id": "000000000000","target_stage_id":
              "applied", "stage_actions_enabled": false }'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/move

        samples-languages:
          - html
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/questionnaire/{candidate_questionnaire_id}:
    post:
      tags:
        - Questionnaire
      summary: ./candidate/:id/questionnaire/:id
      operationId: Questionnaire_saveCandidateResponses
      description: Save candidate responses to a questionnaire
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_questionnaire_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuestionnaireSaveCandidateResponsesRequest'
      responses:
        '204':
          description: '204'
          content:
            application/json:
              examples:
                Result:
                  value: ''
              schema:
                $ref: >-
                  #/components/schemas/QuestionnaireSaveCandidateResponsesResponse
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/QuestionnaireSaveCandidateResponses400Response
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/QuestionnaireSaveCandidateResponses401Response
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "updateCandidateQuestionnaireUnkownError",
                            "message": "there was an unknown error responding to canididate questionnaire."
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/QuestionnaireSaveCandidateResponses500Response
      deprecated: false
      x-readme:
        code-samples:
          - language: http
            code: "POST /v3/company/000000000000/position/000000000000/candidate/000000000000/questionnaire/000000000000 HTTP/1.1\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n\t\"questions\": [\n\t\t{\n\t\t\t\"_id\": \"000000000000\",  //question_id\n\t\t\t\"response\": \"Option Value\"  // syntax for multiplechoice/dropdown type questions\n\t\t},\n\t\t{\n\t\t\t\"_id\": \"000000000000\", //question_id\n\t\t\t\"response\": \"This is the text response\" //syntax for paragraph/text type questions\n\t\t},\n\t\t{\n\t\t\t\"_id\": \"000000000000\", //question_id\n\t\t\t\"responses\": [\"Option Value 1\", \"Option Value 2\"] //syntax for checkboxes type questions - note the key is responses, not response\n\t\t}\n\t\t\n\t]\n}"
          - language: curl
            code: "curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" -X POST -d '{\"questions\": [{\"_id\": \"000000000000\",\"response\": \"Option Value\"},{\"_id\": \"000000000000\",\"response\": \"This is the text response\"},{\"_id\": \"000000000000\", \"responses\": [\"Option Value 1\", \"Option Value 2\"]\t}]}' https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/questionnaire/000000000000\n\n"
        samples-languages:
          - http
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/questionnaires:
    get:
      tags:
        - Questionnaire
      summary: ./candidate/:id/questionnaires
      operationId: Questionnaire_get
      description: Retrieve candidate questionnaires
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    [
                      { CandidateQuestionnaire Object},
                      ...
                    ]
              schema:
                $ref: '#/components/schemas/QuestionnaireGetResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/QuestionnaireGet400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/QuestionnaireGet401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getQuestionnairesError",
                            "message": "there was an unknown error getting candidate questionnaires."
                        }
                    }
              schema:
                $ref: '#/components/schemas/QuestionnaireGet500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/questionnaires
        samples-languages:
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/resume:
    post:
      tags:
        - Company
      summary: ./candidate/:id/resume
      operationId: Company_attachResume
      description: Attach a resume file to an existing candidate
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyAttachResumeRequest'
      responses:
        '204':
          description: '204'
          content:
            application/json:
              examples:
                Result:
                  value: ''
              schema:
                $ref: '#/components/schemas/CompanyAttachResumeResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyAttachResume400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyAttachResume401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "uploadResumeError",
                            "message": "There was an error saving resume."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyAttachResume500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -X POST -H "Authorization:
              00000000-0000-0000-0000-000000000000" -F'data=@/path/to/file'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/resume
        samples-languages:
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/scorecard:
    put:
      tags:
        - Company
      summary: ./candidate/:id/scorecard
      operationId: Company_updateCandidateScorecard
      description: Update candidate scorecard for user
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyUpdateCandidateScorecardRequest'
      responses:
        '204':
          description: '204'
          content:
            application/json:
              examples:
                Result:
                  value: ''
              schema:
                $ref: '#/components/schemas/CompanyUpdateCandidateScorecardResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "addCandidateScorecardScoreInvalid",
                            "message": "'<value>' is not an allowable score. Allowed properties are: very_poor,poor,neutral,good,very_good"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyUpdateCandidateScorecard400Response
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyUpdateCandidateScorecard401Response
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "setCandidateStatusError",
                            "message": "there was an unknown error setting candidate stage."
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyUpdateCandidateScorecard500Response
      deprecated: false
      x-readme:
        code-samples:
          - language: http
            code: >-
              PUT
              /v3/company/000000000000/position/000000000000/candidate/000000000000/scorecard
              HTTP/1.1

              Host: api.breezy.hr

              Authorization: 00000000-0000-0000-0000-000000000000

              Content-Type: application/json


              {
                "score": "very_good",
                "note": "I really love this candidate for this position"
              }
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X PUT -d '{ "stage_id":
              "000000000000" }'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/stage
        samples-languages:
          - http
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/send-questionnaire:
    post:
      tags:
        - Questionnaire
      summary: ./candidate/:id/send-questionnaire
      operationId: Questionnaire_createForCandidate
      description: Create a new questionnaire for a candidate
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
        - name: questionnaire_id
          in: query
          required: true
          schema:
            type: string
        - description: >-
            should the result of this action send an email to the candidate to
            complete questionnaire
          name: email_candidate
          in: query
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    { 
                      CandidateQuestionnaire Object
                    }
              schema:
                $ref: '#/components/schemas/QuestionnaireCreateForCandidateResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "sendQuestionnaireMissingId",
                            "message": "questionnaire_id is null or empty"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/QuestionnaireCreateForCandidate400Response
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/QuestionnaireCreateForCandidate401Response
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getQuestionnairesError",
                            "message": "there was an unknown error getting candidate questionnaires."
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/QuestionnaireCreateForCandidate500Response
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/send-questionnaire?questionnaire_id=000000000000
        samples-languages:
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/stage:
    put:
      tags:
        - Company
      summary: ./candidate/:id/stage
      operationId: Company_moveCandidateStage
      description: Move candidate to specified stage
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyMoveCandidateStageRequest'
      responses:
        '204':
          description: '204'
          content:
            application/json:
              examples:
                Result:
                  value: ''
              schema:
                $ref: '#/components/schemas/CompanyMoveCandidateStageResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "setCandidateStatusMissingStageId",
                            "message": "stage_id is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyMoveCandidateStage400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyMoveCandidateStage401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "setCandidateStatusError",
                            "message": "there was an unknown error setting candidate stage."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyMoveCandidateStage500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: http
            code: >-
              PUT
              /v3/company/000000000000/position/000000000000/candidate/000000000000/stage
              HTTP/1.1

              Host: api.breezy.hr

              Authorization: 00000000-0000-0000-0000-000000000000

              Content-Type: application/json


              {
                "stage_id": "000000000000"  
              }
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X PUT -d '{ "stage_id":
              "000000000000" }'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/stage
        samples-languages:
          - http
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/stream:
    get:
      tags:
        - Company
      summary: ./candidate/:id/stream
      operationId: Company_getPositionCandidateStreamEvents
      description: >-
        Retrieve last 50 candidate discussion stream events by candidate id for
        given position
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    [
                      {
                        "_id": String,
                        "type": "string",
                        "stream_id": String,
                        "object": {}, //stream object specific to type
                        "timestamp": Date
                      },
                      ...
                    ]
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPositionCandidateStreamEventsResponse
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPositionCandidateStreamEvents400Response
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPositionCandidateStreamEvents401Response
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getStreamError",
                            "message": "there was an unknown error getting candidate stream."
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyGetPositionCandidateStreamEvents500Response
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/stream
        samples-languages:
          - curl
    post:
      tags:
        - Company
      summary: ./candidate/:id/stream
      operationId: Company_addCandidateStreamNote
      description: Adds a note to a candidate's discussion stream
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyAddCandidateStreamNoteRequest'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                      "_id": String,
                      "type": "companyNotePosted",
                      "stream_id": String,
                      "object": {}, //stream object specific to type
                      "timestamp": Date
                    }
              schema:
                $ref: '#/components/schemas/CompanyAddCandidateStreamNoteResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "postNoteMissingBody",
                            "message": "body is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyAddCandidateStreamNote400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyAddCandidateStreamNote401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "postNoteError",
                            "message": "there was an unknown error posting message."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyAddCandidateStreamNote500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: html
            code: >-
              POST
              /v3/company/000000000000/position/000000000000/candidate/000000000000/stream
              HTTP/1.1

              Host: api.breezy.hr

              Authorization: 00000000-0000-0000-0000-000000000000

              Content-Type: application/json


              {
                "body": "Hi there! This is a test message!"
              }
          - language: curl
            code: >+
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X POST -d '{ "body": "Hi
              there! This is a test message!" }'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/stream

        samples-languages:
          - html
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/work-history:
    put:
      tags:
        - WorkHistory
      summary: ./candidate/:id/work-history
      operationId: WorkHistory_addEntry
      description: Adds a work history entry to a candidate
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkHistoryAddEntryRequest'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                       Candidate Object
                    }
              schema:
                $ref: '#/components/schemas/WorkHistoryAddEntryResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/WorkHistoryAddEntry400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/WorkHistoryAddEntry401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "updateCandidateError",
                            "message": "there was an unknown error updating candidate."
                        }
                    }
              schema:
                $ref: '#/components/schemas/WorkHistoryAddEntry500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: http
            code: "PUT /v3/company/000000000000/position/000000000000/candidate/000000000000/work-history HTTP/1.1\nHost: app.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n\t\"company_name\": \"Widget Corp\",\n\t\"title\": \"Widget Maker\",\n\t\"summary\": \"I made all the widgets\",\n\t\"start_month\": 1,\n\t\"start_year\": 2015,\n\t\"end_month\": 10,\n\t\"end_year\": 2017\n}"
          - language: curl
            code: >+
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X PUT -d '{"company_name":
              "Widget Corp","title": "Widget Maker","summary": "I made all the
              widgets","start_month": 1,"start_year": 2015,"end_month":
              10,"end_year": 2017 }'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/work-history

        samples-languages:
          - http
          - curl
  /v3/company/{company_id}/position/{position_id}/candidates:
    get:
      tags:
        - Company
      summary: ./candidates
      operationId: Company_getPositionCandidates
      description: >-
        Retrieve candidates for given position with an abbreviated candidate
        object
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - description: 'Add this parameter to force paging of results (max: 50)'
          name: page_size
          in: query
          schema:
            type: integer
            format: int32
        - description: >-
            If page size is passed, this determines which page of data will be
            returned
          name: page
          in: query
          schema:
            type: integer
            format: int32
            default: 1
        - description: >-
            Determines the sort order of the data returned. Can be (created |
            updated)
          name: sort
          in: query
          schema:
            type: string
            default: updated
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n  {\n    \"_id\": String,\n    \"meta_id\": String,\n    \"creation_date\": Date,\n    \"email_address\": String,\n    \"headline\": String,\n    \"initial\": Char(1),\n    \"name\": String,\n    \"origin\": \"applied | sourced | recruiter | referral\",\n    \"phone_number\": String,\n    \"profile_photo_url\": String,\n    \"resume\": {\n      \"file_name\": String,\n      \"url\": String,\n      \"pdf_url\": String\n\t\t},\n    \"source\": {\n      \"id\": String,\n      \"name\": String,\n      \"type\": String\n    },\n    \"stage\": {\n      \"id\": String,\n      \"name\": String,\n      \"type\": {\n        \"id\": String,\n        \"name\": String,\n        \"icon\": String\n      }\n    },\n    \"tags\": [String,...],\n    \"updated_date\": Date\n\t},\n\t...\n]"
              schema:
                $ref: '#/components/schemas/CompanyGetPositionCandidatesResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionCandidates400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionCandidates401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getCandidatesError",
                            "message": "there was an unknown error getting candidates."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetPositionCandidates500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidates?page_size=10&page=1&sort=created
        samples-languages:
          - curl
    post:
      tags:
        - Company
      summary: ./candidates
      operationId: Company_addNewCandidateToPosition
      description: Add a new candidate to a position
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - description: >-
            When origin is "sourced", should stage actions be executed (defaults
            to false). This is always true when origin is "applied"
          name: stage_actions_enabled
          in: query
          schema:
            type: boolean
            default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyAddNewCandidateToPositionRequest'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                       Candidate Object
                    }
              schema:
                $ref: '#/components/schemas/CompanyAddNewCandidateToPositionResponse'
        '202':
          description: '202'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "partialCandidateCreated",
                            "message": "This candidate was created successfully without all required fields set on application form. Candidate has been emailed to complete missing required fields and will be available in Breezy upon completion."
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyAddNewCandidateToPosition202Response
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
                Missing Name:
                  value: |-
                    {
                        "error": {
                            "type": "addCandidateMissingName",
                            "message": "name is null or empty"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyAddNewCandidateToPosition400Response
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyAddNewCandidateToPosition401Response
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "addCandidateError",
                            "message": "there was an unknown error creating candidate."
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CompanyAddNewCandidateToPosition500Response
      deprecated: false
      x-readme:
        code-samples:
          - language: http
            code: "POST /v3/company/000000000000/position/000000000000/candidates HTTP/1.1\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n  \"name\": \"New Candidate\",\n  \"email_address\": \"candidate@emailaddress.com\",\n  \"phone_number\": \"123-456-7890\",\n  \"summary\": \"I will be a good candidate for any job you have!\",\n  \"tags\": [\"technical\", \"junior\"],\n  \"source\": \"LinkedIn\",\n  \"origin\": \"applied\",\n  \"address\": \"1234 Mockingbird Lane\\nTopeka KS, 12345\",\n  \"work_history\": [\n  \t{\n    \t\"company_name\": \"Widget Corp\",\n      \"title\": \"Widget Maker\",\n      \"summary\": \"I made all the widgets\",\n      \"start_month\": 1,\n      \"start_year\": 2015,\n      \"end_month\": 10,\n      \"end_year\": 2017\n    }\n  ],\n  \"education\": [\n  \t{\n    \t\"school_name\": \"Widget School\",\n      \"field_of_study\": \"Widget Making\",\n      \"start_year\": 2017,\n      \"end_year\": 11\n    }\n  ],\n  \"social_profiles\": {\n  \t\"facebook\": \"https://link.to/facebook\",\n    \"github\": \"https://link.to/github\"\n  },\n  \"custom_attributes\": [\n  \t{\n    \tname: \"Desired Salary\",\n      value: \"1000000\",\n      secure: true\n    }\n  ],\n  \"cover_letter\": \"Please consider me\"\n}"
          - language: curl
            code: >+
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X POST -d '{ "name": "New
              Candidate", "email_address": "candidate@emailaddress.com",
              "phone_number": "123-456-7890", "summary": "I will be a good
              candidate for any job you have!", "tags": ["technical", "junior"],
              "source": "LinkedIn","origin": "applied", "address": "1234
              Mockingbird Lane\nTopeka KS, 12345", "work_history":
              [{"company_name": "Widget Corp","title": "Widget Maker","summary":
              "I made all the widgets","start_month": 1,"start_year":
              2015,"end_month": 10,"end_year": 2017}],"education":
              [{"school_name": "Widget School","field_of_study": "Widget
              Making","start_year": 2017,"end_year": 11}], "social_profiles": {
              "facebook": "https://link.to/facebook", "github":
              "https://link.to/github"},"custom_attributes": [ { name: "Desired
              Salary", value: "1000000", secure: true }],"cover_letter": "Please
              consider me" }'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidates

        samples-languages:
          - http
          - curl
  /v3/company/{company_id}/position/{position_id}/candidates/resume:
    post:
      tags:
        - Company
      summary: ./candidates/resume
      operationId: Company_uploadResume
      description: Upload and parse a resume file to create a new candidate
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: position_id
          in: path
          required: true
          schema:
            type: string
        - description: id of pipeline stage to put new candidate in
          name: stage_id
          in: query
          schema:
            type: string
            default: applied
        - description: >-
            execute stage actions configured on stage candidate is being created
            in
          name: stage_actions_enabled
          in: query
          schema:
            type: boolean
            default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyUploadResumeRequest'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                       Candidate Object
                    }
              schema:
                $ref: '#/components/schemas/CompanyUploadResumeResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUploadResume400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUploadResume401Response'
        '409':
          description: '409'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "addCandidateByResumeDuplicate",
                            "message": "this candidate already exists on this position."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUploadResume409Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "addCandidateByResumeError",
                            "message": "there was an unknown error adding candidate by resume."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyUploadResume500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >
              curl -X POST -H "Authorization:
              00000000-0000-0000-0000-000000000000" -F'data=@/path/to/file'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidates/resume?stage_id=applied&stage_actions_enabled=true
        samples-languages:
          - curl
  /v3/company/{company_id}/candidates/search:
    get:
      tags:
        - Company
      summary: ./candidates/search
      operationId: Company_getCandidatesByEmail
      description: Retrieve all candidates with entered email address
      parameters:
        - description: company id
          name: company_id
          in: path
          required: true
          schema:
            type: string
        - name: email_address
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[{\n  _id: String,\n  name: String,\n\tposition: { Position Object }\n}]"
              schema:
                $ref: '#/components/schemas/CompanyGetCandidatesByEmailResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "searchCompanyCandidatesMissingEmail",
                            "message": "email_address is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetCandidatesByEmail400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetCandidatesByEmail401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "searchCompanyCandidatesError",
                            "message": "there was an unknown error getting candidate."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CompanyGetCandidatesByEmail500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/candidates/search?email_address=this@that.com
        samples-languages:
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/custom-fields:
    get:
      tags:
        - CustomField
      summary: ./candidate/:id/custom-fields
      operationId: CustomField_get
      description: ''
      parameters:
        - description: company id
          name: company_id
          in: path
          schema:
            type: string
          required: true
        - description: position id
          name: position_id
          in: path
          schema:
            type: string
          required: true
        - description: candidate id
          name: candidate_id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    [
                      Candidate Custom Field Object
                    ]
              schema:
                $ref: '#/components/schemas/CustomFieldGetResponse'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CustomFieldGet400Response'
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: '#/components/schemas/CustomFieldGet401Response'
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "getCandidateCustomFieldsError",
                            "message": "there was an unknown error getting candidate custom fields."
                        }
                    }
              schema:
                $ref: '#/components/schemas/CustomFieldGet500Response'
      deprecated: false
      x-readme:
        code-samples:
          - language: curl
            code: >-
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000"
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/custom-fields
        samples-languages:
          - curl
  /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/custom-fields/{custom_field_id}:
    put:
      tags:
        - CustomField
      summary: ./candidate/:id/custom-fields/:id
      operationId: CustomField_updateCandidateCustomFields
      description: ''
      parameters:
        - description: company id
          name: company_id
          in: path
          schema:
            type: string
          required: true
        - description: position id
          name: position_id
          in: path
          schema:
            type: string
          required: true
        - description: candidate id
          name: candidate_id
          in: path
          schema:
            type: string
          required: true
        - description: custom field id
          name: custom_field_id
          in: path
          schema:
            type: string
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/CustomFieldUpdateCandidateCustomFieldsRequest
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    [
                      Candidate Custom Field Object
                    ]
              schema:
                $ref: >-
                  #/components/schemas/CustomFieldUpdateCandidateCustomFieldsResponse
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Missing Access Token:
                  value: |-
                    {
                        "error": {
                            "type": "missingAccessToken",
                            "message": "access token is null or empty"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CustomFieldUpdateCandidateCustomFields400Response
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "invalidAccessToken",
                            "message": "access token is invalid"
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CustomFieldUpdateCandidateCustomFields401Response
        '500':
          description: '500'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "error": {
                            "type": "updateCandidateCustomFieldsError",
                            "message": "there was an unknown error updating candidate fields."
                        }
                    }
              schema:
                $ref: >-
                  #/components/schemas/CustomFieldUpdateCandidateCustomFields500Response
      deprecated: false
      x-readme:
        code-samples:
          - language: http
            code: "PUT /v3/company/000000000000/position/000000000000/candidate/000000000000/custom-fields/000000000000\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n\t\"value\": \"new value\"\n}"
          - language: curl
            code: >
              curl -H "Content-Type: application/json" -H "Authorization:
              00000000-0000-0000-0000-000000000000" -X PUT -d '{ "value": "new
              value"}'
              https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/custom-fields/000000000000
        samples-languages:
          - http
          - curl
components:
  securitySchemes:
    sec0:
      type: apiKey
      name: Authorization
      in: header
      x-default: 0000000-0000-0000-0000-00000000001
  schemas:
    AuthenticationGetAccessTokenRequest:
      type: object
      required:
        - email
        - password
      properties:
        email:
          description: Email address of user
          type: string
        password:
          description: Password of user
          type: string
    CompanyUpdatePositionDetailsRequest:
      type: object
      properties:
        tags:
          type: array
          items:
            type: string
        description:
          type: string
        name:
          type: string
        type:
          description: fullTime | partTime | contract | temporary | other
          type: string
        location:
          type: object
          properties: {}
        department:
          type: string
        requisition_id:
          type: string
        category:
          description: >-
            software | design | product | sysadmin | devops | finance | custserv
            | sales | marketing | pr | design-not-interactive | hr | management
            | operations | other
          type: string
        experience:
          description: >-
            na | internship | entry-level | associate | mid-level | senior-level
            | executive
          type: string
        education:
          description: >-
            unspecified | high-school | certification | vocational |
            associate-degree | bachelor-degree | masters-degree | doctorate |
            professional | some-college | vocational-diploma | vocational-degree
            | some-high-school
          type: string
        custom_attributes:
          description: >-
            { name: String, value: String, secure: Boolean } - secure determines
            if the value should be encrypted at rest
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        pipeline_id:
          type: string
        scorecard_id:
          type: string
        questionnaire_id:
          type: string
    CompanyUpdatePositionStateRequest:
      type: object
      required:
        - state
      properties:
        state:
          description: published | draft | closed | archived
          type: string
    CompanyCreateNewPositionRequest:
      type: object
      required:
        - name
        - description
        - type
        - location
      properties:
        tags:
          type: array
          items:
            type: string
        description:
          type: string
        name:
          type: string
        type:
          description: fullTime | partTime | contract | temporary | other
          type: string
        location:
          type: object
          properties: {}
        department:
          type: string
        requisition_id:
          type: string
        category:
          description: >-
            software | design | product | sysadmin | devops | finance | custserv
            | sales | marketing | pr | design-not-interactive | hr | management
            | operations | other
          type: string
        experience:
          description: >-
            na | internship | entry-level | associate | mid-level | senior-level
            | executive
          type: string
        education:
          description: >-
            unspecified | high-school | certification | vocational |
            associate-degree | bachelor-degree | masters-degree | doctorate |
            professional | some-college | vocational-diploma | vocational-degree
            | some-high-school
          type: string
        custom_attributes:
          description: >-
            { name: String, value: String, secure: Boolean } - secure determines
            if the value should be encrypted at rest
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        pipeline_id:
          type: string
          default: default
        scorecard_id:
          type: string
        questionnaire_id:
          type: string
    CompanyUpdateCustomFieldRequest:
      type: object
      properties:
        value:
          type: string
    CompanyUpdateCandidatePositionRequest:
      type: object
      properties:
        tags:
          type: array
          items:
            type: string
        summary:
          type: string
        name:
          type: string
        email_address:
          type: string
        phone_number:
          type: string
        source:
          description: custom source to attribute to the incoming candidate
          type: string
          default: Breezy API
        headline:
          type: string
        address:
          type: string
        social_profiles:
          description: >-
            valid properties ( facebook | linkedin | twitter | dribbble |
            instagram | behance | angellist | flickr | github | youtube |
            google-plus | skype | globe )
          type: object
          properties: {}
        cover_letter:
          type: string
    ConversationAddMessageRequest:
      type: object
      properties:
        body:
          description: the content of the conversation to add
          type: string
    CustomAttributeAddToCandidateCustomAttributeRequest:
      type: object
      required:
        - name
        - value
      properties:
        name:
          type: string
        value:
          type: string
        secure:
          description: Does this value need to be encrypted at rest?
          type: boolean
          default: false
    CompanyAddEducationEntryRequest:
      type: object
      required:
        - school_name
      properties:
        school_name:
          type: string
        field_of_study:
          type: string
        start_year:
          type: integer
          format: int32
        end_year:
          type: integer
          format: int32
    CompanyMoveCandidateToPositionRequest:
      type: object
      required:
        - target_position_id
        - target_stage_id
      properties:
        target_position_id:
          type: string
        target_stage_id:
          type: string
        stage_actions_enabled:
          description: >-
            Execute stage actions on the target position / stage if they are
            configured
          type: boolean
          default: false
    QuestionnaireSaveCandidateResponsesRequest:
      type: object
      required:
        - questions
      properties:
        questions:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
    CompanyAttachResumeRequest:
      type: object
      properties:
        file:
          description: must be sent as `form-data` with the field name `file`
          type: string
          format: binary
    CompanyUpdateCandidateScorecardRequest:
      type: object
      required:
        - score
      properties:
        score:
          description: The score code (very_poor, poor, neutral, good, very_good)
          type: string
        note:
          description: Note to add with the score.
          type: string
    CompanyMoveCandidateStageRequest:
      type: object
      properties:
        stage_id:
          description: >-
            The ID of the Pipeline stage to put the candidate in (hired,
            disqualified, offer, feedback, interviewing, applied)
          type: string
    CompanyAddCandidateStreamNoteRequest:
      type: object
      properties:
        body:
          description: the content of the note to add
          type: string
    WorkHistoryAddEntryRequest:
      type: object
      required:
        - company_name
      properties:
        summary:
          type: string
        title:
          type: string
        company_name:
          type: string
        start_month:
          type: integer
          format: int32
        start_year:
          type: integer
          format: int32
        end_month:
          type: integer
          format: int32
        end_year:
          type: integer
          format: int32
    CompanyAddNewCandidateToPositionRequest:
      type: object
      required:
        - name
      properties:
        tags:
          type: array
          items:
            type: string
        summary:
          type: string
        name:
          type: string
        email_address:
          description: '*required when origin is "applied"'
          type: string
        phone_number:
          type: string
        address:
          type: string
        origin:
          description: >-
            ( sourced | applied ) -> will indicate in Breezy if the candidate
            should be marked as sourced or applied
          type: string
          default: sourced
        source:
          description: custom source to attribute to the incoming candidate
          type: string
          default: Breezy API
        work_history:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        education:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        social_profiles:
          description: >-
            valid properties ( facebook | linkedin | twitter | dribbble |
            instagram | behance | angellist | flickr | github | youtube |
            google-plus | skype | globe )
          type: object
          properties: {}
        custom_attributes:
          description: >-
            { name: String, value: String, secure: Boolean } - secure determines
            if the value should be encrypted at rest
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        cover_letter:
          type: string
    CompanyUploadResumeRequest:
      type: object
      properties:
        file:
          description: must be sent as `form-data` with the field name of `file`
          type: string
          format: binary
    CustomFieldUpdateCandidateCustomFieldsRequest:
      type: object
      properties:
        value:
          type: string
    AuthenticationGetAccessTokenResponse:
      type: string
      example: |-
        {
            "access_token": "00000000-0000-0000-0000-000000000000",
            "user": { User }
        }
    AuthenticationGetAccessToken400Response:
      oneOf:
        - title: Missing Email Address
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: signinEmailError
                message:
                  type: string
                  example: email is null or empty
        - title: Missing Password
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: signinPasswordError
                message:
                  type: string
                  example: password is null or empty
    AuthenticationGetAccessToken401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: signinFailure
            message:
              type: string
              example: email or password incorrect.
    AuthenticationGetAccessToken500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: accessTokenCreationError
            message:
              type: string
              example: There was an error creating Access Token.
    SessionInvalidateTokenResponse:
      type: string
      example: ''
    UserGetByIdResponse:
      type: string
      example: '{ User }'
    UserGetById400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    UserGetById401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    UserGetById404Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: userNotFound
            message:
              type: string
              example: user not found.
    UserGetById500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getUserError
            message:
              type: string
              example: there was an unknown error getting user.
    UserGetCompanyDetailsResponse:
      type: string
      example: "[ \n\t\"<company_id>\": {\n\t\t\"company\": { Company },\n    \"messaging\": {\n\t\t\t\"questionnaire_template\": {\n        \"type\": String,\n        \"body\": String\n\t\t\t},\n      \"subject_template\": {\n        \"type\": String\n        \"body\": String\n      }\n\t\t},\n    \"reasons\": {\n    \t\"disposition\": [\n        {\n          \"name\": String,\n          \"_id\": String\n        }, . . .               \n      ],\n    \t\"creation_date\": Date,\n    \t\"updated_date\": Date\n    },\n    \"questionnaires\": [           \n    \t{ Questionnaire },\n      ...            \n    ],\n    \"pipelines\": {\n      \"<pipeline_id>\": { Pipeline },\n      ...           \n    },\n    \"interview_guides\": [\n      { Interview Guide },\n      ...\n    ],\n    \"templates\": [\n      { Template },\n      ...        \n    ],\n    \"tasks\": [\n      { Task },\n      ...        \n    ],\n    \"scorecards\": [\n      { Scorecard },\n      ... \n    ],\n    \"user_settings\": {\n      \"webcal_uri\": String \n    },\n    \"positions\": {\n      \"<position_id>\": { Position },\n      ...\n    },\n    \"members\": [\n      { User },\n      ...\n    ]\n  },\n\t...\n]"
    UserGetCompanyDetails400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    UserGetCompanyDetails401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    UserGetCompanyDetails404Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: userNotFound
            message:
              type: string
              example: user not found.
    UserGetCompanyDetails500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getUserCompaniesDetailError
            message:
              type: string
              example: there was an unknown error getting user company details.
    CompanyGetInformationResponse:
      type: string
      example: |-
        { 
          Company Object
        }
    CompanyGetInformation400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetInformation401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetInformation500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getCompanyError
            message:
              type: string
              example: there was an unknown error getting company.
    CompanyGetCandidateCustomAttributesResponse:
      type: string
      example: "[\n  {\n  \t\"id\": String,\n\t\t\"name\": String,\n\t\t\"secure\": Boolean\n  },\n  ...\n],"
    CompanyGetCandidateCustomAttributes400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetCandidateCustomAttributes401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetCandidateCustomAttributes500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getCustomAttributesError
            message:
              type: string
              example: there was an unknown error getting custom attributes.
    CompanyGetPositionCustomAttributesResponse:
      type: string
      example: "[\n  {\n  \t\"id\": String,\n\t\t\"name\": String,\n\t\t\"secure\": Boolean\n  },\n  ...\n],"
    CompanyGetPositionCustomAttributes400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetPositionCustomAttributes401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetPositionCustomAttributes500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getCustomAttributesError
            message:
              type: string
              example: there was an unknown error getting custom attributes.
    CompanyGetPipelineStagesByPipelineIdResponse:
      type: string
      example: |-
        [ // all stages on pipeline
          {
            "id": "applied",
            "name": "Applied",
            "icon": "user",
            "action_count": 0,
            "actions": {},
            "type": "type",
            "action": "action"
          } . . .
        ]
    CompanyGetPipelineStagesByPipelineId400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetPipelineStagesByPipelineId401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetPipelineStagesByPipelineId500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getPipelineError
            message:
              type: string
              example: there was an unknown error getting pipeline.
    CompanyGetPipelinesResponse:
      type: string
      example: "[\n\t\"<pipeline_id>\": {\n    Pipeline Object\n  },\n  ...\n]"
    CompanyGetPipelines400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetPipelines401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetPipelines500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getPipelinesError
            message:
              type: string
              example: there was an unknown error getting pipelines.
    CompanyGetQuestionnaireByIdResponse:
      type: string
      example: |-
        { 
          Questionnaire Object
        }
    CompanyGetQuestionnaireById400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetQuestionnaireById401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetQuestionnaireById500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getTemplateError
            message:
              type: string
              example: there was an unknown error getting questionnaire.
    CompanyGetQuestionnairesResponse:
      type: string
      example: |-
        [
          { Questionnaire Object },
          ...
        ],
    CompanyGetQuestionnaires400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetQuestionnaires401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetQuestionnaires500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getTemplateError
            message:
              type: string
              example: there was an unknown error getting questionnaires.
    CompanyGetEmailTemplateByIdResponse:
      type: string
      example: |-
        { 
          Template Object
        }
    CompanyGetEmailTemplateById400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetEmailTemplateById401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetEmailTemplateById500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getTemplateError
            message:
              type: string
              example: there was an unknown error getting template.
    CompanyGetAllTemplatesResponse:
      type: string
      example: |-
        [
          { Template Object },
          ...
        ],
    CompanyGetAllTemplates400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetAllTemplates401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetAllTemplates500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getTemplateError
            message:
              type: string
              example: there was an unknown error getting template.
    CompanyGetAssociatedResponse:
      type: string
      example: "[\n\t{ Company Object},\n  ...\n]"
    CompanyGetAssociated400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetAssociated401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetAssociated500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getCompaniesError
            message:
              type: string
              example: there was an unknown error getting companies.
    CompanyGetPositionDetailsResponse:
      type: string
      example: |-
        { 
          Position Object      
        }
    CompanyGetPositionDetails400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetPositionDetails401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetPositionDetails500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getPositionError
            message:
              type: string
              example: there was an unknown error getting position.
    CompanyUpdatePositionDetailsResponse:
      type: string
      example: |-
        {
           Position Object
        }
    CompanyUpdatePositionDetails400Response:
      oneOf:
        - title: Missing Access Token
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: missingAccessToken
                message:
                  type: string
                  example: access token is null or empty
        - title: Missing Required Field
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: addPosition<Field>Missing
                message:
                  type: string
                  example: <field> is null or empty
        - type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: addPositionFieldInvalid
                message:
                  type: string
                  example: '<field>  must be one of the following values: <values>'
    CompanyUpdatePositionDetails401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyUpdatePositionDetails500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: updatePositionError
            message:
              type: string
              example: there was an unknown error updating position.
    CompanyUpdatePositionStateResponse:
      type: string
      example: ''
    CompanyUpdatePositionState400Response:
      oneOf:
        - title: Missing Access Token
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: missingAccessToken
                message:
                  type: string
                  example: access token is null or empty
        - title: Missing Required Field
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: addPosition<Field>Missing
                message:
                  type: string
                  example: <field> is null or empty
        - type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: addPositionFieldInvalid
                message:
                  type: string
                  example: '<field>  must be one of the following values: <values>'
    CompanyUpdatePositionState401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyUpdatePositionState500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: updatePositionError
            message:
              type: string
              example: there was an unknown error updating position.
    CompanyGetPositionStreamResponse:
      type: string
      example: |-
        [
          {
            "_id": String,            
            "type": String,
            "stream_id": String,
            "object": {}, //the notification object specific to the notificationType above
            "timestamp": Date
          },
          ...
        ]
    CompanyGetPositionStream400Response:
      type: object
      properties:
        error:
          type: string
          example: No access token found
    CompanyGetPositionTeamMembersResponse:
      type: string
      example: "[\n   {\n      \"_id\": String,\n      \"email_address\": String,\n      \"name\": String,\n      \"username\": String,\n      \"initial\": Char(1),\n      \"creation_date\": Date,\n      \"verified_email\": Boolean,\n      \"tz_offset\": String,\n      \"signature\": {\n        \"enabled\": Boolean,\n        \"body\": String\n      },\n      \"updated_date\": Date,\n      \"user_role\": {\n\t\t\t\t\"id\": \"member | hiring_manager\",\n\t\t\t\t\"name\": \"Hiring Team Member | Hiring Manager\"\n\t\t\t}\n   }\n]"
    CompanyGetPositionTeamMembers400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetPositionTeamMembers401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetPositionTeamMembers500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getPositionTeamError
            message:
              type: string
              example: there was an unknown error getting position team.
    CompanyGetPositionsByStateResponse:
      type: string
      example: "[\n\t{ Position Object },\n  ...\n]"
    CompanyGetPositionsByState400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetPositionsByState401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetPositionsByState500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getPositionsError
            message:
              type: string
              example: there was an unknown error getting positions.
    CompanyCreateNewPositionResponse:
      type: string
      example: |-
        {
           Position Object
        }
    CompanyCreateNewPosition400Response:
      oneOf:
        - title: Missing Access Token
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: missingAccessToken
                message:
                  type: string
                  example: access token is null or empty
        - title: Missing Required Field
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: addPosition<Field>Missing
                message:
                  type: string
                  example: <field> is null or empty
        - type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: addPositionFieldInvalid
                message:
                  type: string
                  example: '<field>  must be one of the following values: <values>'
    CompanyCreateNewPosition401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyCreateNewPosition500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: addPositionError
            message:
              type: string
              example: there was an unknown error creating position.
    CompanyGetPositionCustomFieldsResponse:
      type: string
      example: "[\n\tPosition Custom Field Object\n]"
    CompanyGetPositionCustomFields400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetPositionCustomFields401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetPositionCustomFields500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getPositionCustomFieldsError
            message:
              type: string
              example: there was an unknown error getting position custom fields.
    CompanyUpdateCustomFieldResponse:
      type: string
      example: "[\n\tPosition Custom Field Object\n]"
    CompanyUpdateCustomField400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyUpdateCustomField401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyUpdateCustomField500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: updatePositionCustomFieldsError
            message:
              type: string
              example: there was an unknown error updating position fields.
    CompanyGetCandidateByIdResponse:
      type: string
      example: "{\n\tCandidate Object\n}"
    CompanyGetCandidateById400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetCandidateById401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetCandidateById500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getCandidateErrror
            message:
              type: string
              example: there was an unknown error getting candidate.
    CompanyUpdateCandidatePositionResponse:
      type: string
      example: |-
        {
           Candidate Object
        }
    CompanyUpdateCandidatePosition400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyUpdateCandidatePosition401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyUpdateCandidatePosition500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: updateCandidateError
            message:
              type: string
              example: there was an unknown error updating candidate.
    CompanyGetAssessmentsResponse:
      type: string
      example: "{\n\tAssessment Object\n}"
    CompanyGetAssessments400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetAssessments401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetAssessments500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getCandidateAssessmentsErrror
            message:
              type: string
              example: there was an unknown error getting candidate assessments
    BackgroundCheckGetAllResponse:
      type: string
      example: "{\n\tBackground Check Object\n}"
    BackgroundCheckGetAll400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    BackgroundCheckGetAll401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    BackgroundCheckGetAll500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getCandidateAssessmentsErrror
            message:
              type: string
              example: there was an unknown error getting candidate background checks
    ConversationGetStreamResponse:
      type: string
      example: "[\n  {\n    \"_id\": String,\n    \"type\": \"messageToCandidatePosted | messageFromCandidatePosted\",\n    \"object\": {\n      \"body\": String,\n      \"subject\": Subject,\n      \"attachments\": [\n        {\n      \t\t\"status\": String,\n        \t\"file_name\": String,\n        \t\"url\": String,\n        \t\"content_type\": String\n        },\n        ...\n      ],      \n      \"candidate_id\": String,\n      \"company_id\": String,\n      \"position_id\": String,\n      \"acting_user\": { Candidate | User}\n    },\n    \"timestamp\": Date\n  }\n]"
    ConversationGetStream400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    ConversationGetStream401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    ConversationGetStream500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getConversationError
            message:
              type: string
              example: there was an unknown error getting candidate conversation.
    ConversationAddMessageResponse:
      type: string
      example: "{\n  \"_id\": String,\n  \"type\": \"messageToCandidatePosted\",\n  \"object\": {\n    \"body\": String,\n    \"subject\": Subject,\n    \"attachments\": [\n      {\n        \"status\": String,\n        \"file_name\": String,\n        \"url\": String,\n        \"content_type\": String\n      },\n      ...\n    ],      \n\t\t\"candidate_id\": String,\n\t\t\"company_id\": String,\n\t\t\"position_id\": String,\n\t\t\"acting_user\": { Candidate | User}\n\t},\n\t\"timestamp\": Date\n}"
    ConversationAddMessage400Response:
      oneOf:
        - title: Missing Access Token
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: missingAccessToken
                message:
                  type: string
                  example: access token is null or empty
        - type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: postConversationMissingBody
                message:
                  type: string
                  example: body is null or empty
    ConversationAddMessage401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    ConversationAddMessage500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: postMessageError
            message:
              type: string
              example: there was an unknown error posting message.
    CustomAttributeAddToCandidateCustomAttributeResponse:
      type: string
      example: |-
        {
           Candidate Object
        }
    CustomAttributeAddToCandidateCustomAttribute400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CustomAttributeAddToCandidateCustomAttribute401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CustomAttributeAddToCandidateCustomAttribute500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: updateCandidateError
            message:
              type: string
              example: there was an unknown error updating candidate.
    CompanyGetCandidateDocumentsByPositionResponse:
      type: string
      example: "[\n\t{\n\t\t\"_id\": String,\n\t\t\"company_id\": String,\n\t\t\"position_id\": String,        \n\t\t\"candidate_id\": String,\n\t\t\"acting_user\": { User | Candidate},\n\t\t\"file_name\": String,\n\t\t\"file_url\": String,\n\t\t\"file_size\": Integer,\n\t\t\"creation_date\": Date\n\t},\n  ...\n]"
    CompanyGetCandidateDocumentsByPosition400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetCandidateDocumentsByPosition401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetCandidateDocumentsByPosition500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getDocumentsError
            message:
              type: string
              example: there was an unknown error getting documents.
    CompanyAddCandidateDocumentResponse:
      type: string
      example: |-
        {
          "_id": String,
          "company_id": String,
          "position_id": String,        
          "candidate_id": String,
          "acting_user": { User },
          "file_name": String,
          "file_url": String,
          "file_size": Integer,
          "creation_date": Date
        }
    CompanyAddCandidateDocument400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyAddCandidateDocument401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyAddCandidateDocument500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: addDocumentError
            message:
              type: string
              example: there was an unknown error saving document.
    CompanyAddEducationEntryResponse:
      type: string
      example: |-
        {
           Candidate Object
        }
    CompanyAddEducationEntry400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyAddEducationEntry401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyAddEducationEntry500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: updateCandidateError
            message:
              type: string
              example: there was an unknown error updating candidate.
    CompanyGetPositionCandidateMetaResponse:
      type: object
      properties:
        tasks:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        background_checks:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        notepad:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        team_notepad:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        assessments:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        stream:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        schedule:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        documents:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        questionnaires:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        conversation:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        references:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        scorecards:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
    CompanyGetPositionCandidateMeta400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetPositionCandidateMeta401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetPositionCandidateMeta500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getCandidateMetadataError
            message:
              type: string
              example: there was an unknown error getting candidate metadata.
    CompanyMoveCandidateToPositionResponse:
      type: string
      example: '{ Candidate Object }'
    CompanyMoveCandidateToPosition400Response:
      oneOf:
        - title: Missing Access Token
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: missingAccessToken
                message:
                  type: string
                  example: access token is null or empty
        - type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: moveCandidateMissingStage
                message:
                  type: string
                  example: target_stage_id is null or empty
        - type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: moveCandidateMissingPosition
                message:
                  type: string
                  example: target_position_id is null or empty
    CompanyMoveCandidateToPosition401Response:
      oneOf:
        - type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: invalidAccessToken
                message:
                  type: string
                  example: access token is invalid
        - type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: moveCandidateUserNotAuthorized
                message:
                  type: string
                  example: user does not have proper access to target position
    CompanyMoveCandidateToPosition404Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: moveCandidatePositionNotFound
            message:
              type: string
              example: target position not found
    CompanyMoveCandidateToPosition500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: postMessageError
            message:
              type: string
              example: there was an unknown error posting message.
    QuestionnaireSaveCandidateResponsesResponse:
      type: string
      example: ''
    QuestionnaireSaveCandidateResponses400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    QuestionnaireSaveCandidateResponses401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    QuestionnaireSaveCandidateResponses500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: updateCandidateQuestionnaireUnkownError
            message:
              type: string
              example: >-
                there was an unknown error responding to canididate
                questionnaire.
    QuestionnaireGetResponse:
      type: string
      example: |-
        [
          { CandidateQuestionnaire Object},
          ...
        ]
    QuestionnaireGet400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    QuestionnaireGet401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    QuestionnaireGet500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getQuestionnairesError
            message:
              type: string
              example: there was an unknown error getting candidate questionnaires.
    CompanyAttachResumeResponse:
      type: string
      example: ''
    CompanyAttachResume400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyAttachResume401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyAttachResume500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: uploadResumeError
            message:
              type: string
              example: There was an error saving resume.
    CompanyUpdateCandidateScorecardResponse:
      type: string
      example: ''
    CompanyUpdateCandidateScorecard400Response:
      oneOf:
        - title: Missing Access Token
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: missingAccessToken
                message:
                  type: string
                  example: access token is null or empty
        - type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: addCandidateScorecardMissingScore
                message:
                  type: string
                  example: score is required
        - type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: addCandidateScorecardScoreInvalid
                message:
                  type: string
                  example: >-
                    '<value>' is not an allowable score. Allowed properties are:
                    very_poor,poor,neutral,good,very_good
    CompanyUpdateCandidateScorecard401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyUpdateCandidateScorecard500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: setCandidateStatusError
            message:
              type: string
              example: there was an unknown error setting candidate stage.
    QuestionnaireCreateForCandidateResponse:
      type: string
      example: |-
        { 
          CandidateQuestionnaire Object
        }
    QuestionnaireCreateForCandidate400Response:
      oneOf:
        - title: Missing Access Token
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: missingAccessToken
                message:
                  type: string
                  example: access token is null or empty
        - type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: sendQuestionnaireMissingId
                message:
                  type: string
                  example: questionnaire_id is null or empty
    QuestionnaireCreateForCandidate401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    QuestionnaireCreateForCandidate500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getQuestionnairesError
            message:
              type: string
              example: there was an unknown error getting candidate questionnaires.
    CompanyMoveCandidateStageResponse:
      type: string
      example: ''
    CompanyMoveCandidateStage400Response:
      oneOf:
        - title: Missing Access Token
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: missingAccessToken
                message:
                  type: string
                  example: access token is null or empty
        - type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: setCandidateStatusMissingStageId
                message:
                  type: string
                  example: stage_id is null or empty
    CompanyMoveCandidateStage401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyMoveCandidateStage500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: setCandidateStatusError
            message:
              type: string
              example: there was an unknown error setting candidate stage.
    CompanyGetPositionCandidateStreamEventsResponse:
      type: string
      example: |-
        [
          {
            "_id": String,
            "type": "string",
            "stream_id": String,
            "object": {}, //stream object specific to type
            "timestamp": Date
          },
          ...
        ]
    CompanyGetPositionCandidateStreamEvents400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetPositionCandidateStreamEvents401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetPositionCandidateStreamEvents500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getStreamError
            message:
              type: string
              example: there was an unknown error getting candidate stream.
    CompanyAddCandidateStreamNoteResponse:
      type: string
      example: |-
        {
          "_id": String,
          "type": "companyNotePosted",
          "stream_id": String,
          "object": {}, //stream object specific to type
          "timestamp": Date
        }
    CompanyAddCandidateStreamNote400Response:
      oneOf:
        - title: Missing Access Token
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: missingAccessToken
                message:
                  type: string
                  example: access token is null or empty
        - type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: postNoteMissingBody
                message:
                  type: string
                  example: body is null or empty
    CompanyAddCandidateStreamNote401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyAddCandidateStreamNote500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: postNoteError
            message:
              type: string
              example: there was an unknown error posting message.
    WorkHistoryAddEntryResponse:
      type: string
      example: |-
        {
           Candidate Object
        }
    WorkHistoryAddEntry400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    WorkHistoryAddEntry401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    WorkHistoryAddEntry500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: updateCandidateError
            message:
              type: string
              example: there was an unknown error updating candidate.
    CompanyGetPositionCandidatesResponse:
      type: string
      example: "[\n  {\n    \"_id\": String,\n    \"meta_id\": String,\n    \"creation_date\": Date,\n    \"email_address\": String,\n    \"headline\": String,\n    \"initial\": Char(1),\n    \"name\": String,\n    \"origin\": \"applied | sourced | recruiter | referral\",\n    \"phone_number\": String,\n    \"profile_photo_url\": String,\n    \"resume\": {\n      \"file_name\": String,\n      \"url\": String,\n      \"pdf_url\": String\n\t\t},\n    \"source\": {\n      \"id\": String,\n      \"name\": String,\n      \"type\": String\n    },\n    \"stage\": {\n      \"id\": String,\n      \"name\": String,\n      \"type\": {\n        \"id\": String,\n        \"name\": String,\n        \"icon\": String\n      }\n    },\n    \"tags\": [String,...],\n    \"updated_date\": Date\n\t},\n\t...\n]"
    CompanyGetPositionCandidates400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyGetPositionCandidates401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetPositionCandidates500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getCandidatesError
            message:
              type: string
              example: there was an unknown error getting candidates.
    CompanyAddNewCandidateToPositionResponse:
      type: string
      example: |-
        {
           Candidate Object
        }
    CompanyAddNewCandidateToPosition202Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: partialCandidateCreated
            message:
              type: string
              example: >-
                This candidate was created successfully without all required
                fields set on application form. Candidate has been emailed to
                complete missing required fields and will be available in Breezy
                upon completion.
    CompanyAddNewCandidateToPosition400Response:
      oneOf:
        - title: Missing Access Token
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: missingAccessToken
                message:
                  type: string
                  example: access token is null or empty
        - title: Missing Name
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: addCandidateMissingName
                message:
                  type: string
                  example: name is null or empty
    CompanyAddNewCandidateToPosition401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyAddNewCandidateToPosition500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: addCandidateError
            message:
              type: string
              example: there was an unknown error creating candidate.
    CompanyUploadResumeResponse:
      type: string
      example: |-
        {
           Candidate Object
        }
    CompanyUploadResume400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CompanyUploadResume401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyUploadResume409Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: addCandidateByResumeDuplicate
            message:
              type: string
              example: this candidate already exists on this position.
    CompanyUploadResume500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: addCandidateByResumeError
            message:
              type: string
              example: there was an unknown error adding candidate by resume.
    CompanyGetCandidatesByEmailResponse:
      type: string
      example: "[{\n  _id: String,\n  name: String,\n\tposition: { Position Object }\n}]"
    CompanyGetCandidatesByEmail400Response:
      oneOf:
        - title: Missing Access Token
          type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: missingAccessToken
                message:
                  type: string
                  example: access token is null or empty
        - type: object
          properties:
            error:
              type: object
              properties:
                type:
                  type: string
                  example: searchCompanyCandidatesMissingEmail
                message:
                  type: string
                  example: email_address is null or empty
    CompanyGetCandidatesByEmail401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CompanyGetCandidatesByEmail500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: searchCompanyCandidatesError
            message:
              type: string
              example: there was an unknown error getting candidate.
    CustomFieldGetResponse:
      type: string
      example: |-
        [
          Candidate Custom Field Object
        ]
    CustomFieldGet400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CustomFieldGet401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CustomFieldGet500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: getCandidateCustomFieldsError
            message:
              type: string
              example: there was an unknown error getting candidate custom fields.
    CustomFieldUpdateCandidateCustomFieldsResponse:
      type: string
      example: |-
        [
          Candidate Custom Field Object
        ]
    CustomFieldUpdateCandidateCustomFields400Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: missingAccessToken
            message:
              type: string
              example: access token is null or empty
    CustomFieldUpdateCandidateCustomFields401Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalidAccessToken
            message:
              type: string
              example: access token is invalid
    CustomFieldUpdateCandidateCustomFields500Response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: updateCandidateCustomFieldsError
            message:
              type: string
              example: there was an unknown error updating candidate fields.
security:
  - sec0: []
x-readme:
  headers: []
  explorer-enabled: true
  proxy-enabled: true
x-readme-fauxas: true
_id: 63053e6d9807941f67a926d7:60f86d7494f1a400728ff55d