Small Improvements

Small Improvements companies-email-templates-resource API

Companies Email Templates Resource

GitHub OpenAPI

Documentation

📖
Documentation
https://intercomdocs.small-improvements.com/en/articles/9151054-small-improvements-rest-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/small-improvements/refs/heads/main/openapi/small-improvements-companies-email-templates-resource-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/small-improvements/refs/heads/main/json-schema/

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/small-improvements/refs/heads/main/examples/
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/small-improvements/refs/heads/main/vocabulary/small-improvements-vocabulary.yml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/small-improvements/refs/heads/main/json-ld/small-improvements-context.jsonld

OpenAPI Specification

small-improvements-companies-email-templates-resource-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  description: The Small Improvements REST API (v2) provides programmatic access to the core performance management platform, covering users, feedback cycles, review questionnaires, objectives, 1:1 meetings, pulse surveys, praise, messages, and administrative settings. Authentication uses personal Bearer access tokens generated from user profile settings.
  version: '2.0'
  title: Small Improvements action-item-resource companies-email-templates-resource API
  contact:
    url: https://www.small-improvements.com
    name: Small Improvements
  x-api-id: small-improvements-rest-api
servers:
- url: https://app.small-improvements.com/api
  description: Small Improvements API
security:
- BearerAuth: []
tags:
- name: companies-email-templates-resource
  description: Companies Email Templates Resource
paths:
  /v2/companies/{companyId}/emails/modifications:
    get:
      tags:
      - companies-email-templates-resource
      summary: getModifications
      operationId: getModificationsUsingGET
      parameters:
      - name: companyId
        in: path
        description: companyId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmailTemplateModificationInfo'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v2/companies/{companyId}/emails/preview/{type}:
    get:
      tags:
      - companies-email-templates-resource
      summary: getPreview
      operationId: getPreviewUsingGET
      parameters:
      - name: companyId
        in: path
        description: companyId
        required: true
        schema:
          type: string
      - name: type
        in: path
        description: type
        required: true
        schema:
          type: string
          enum:
          - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWEES
          - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWERS
          - ANYTIME_FEEDBACK_INVITATION_ABOUT_OTHERS
          - ANYTIME_FEEDBACK_INVITATION_ABOUT_SELF
          - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_OTHERS
          - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_SELF
          - ANYTIME_FEEDBACK_REQUESTED_ABOUT_YOU
          - ANYTIME_FEEDBACK_SELF_REFLECTION
          - ANYTIME_FEEDBACK_SHARED_WITH_REPORT
          - ANYTIME_FEEDBACK_SHARED_WITH_YOU
          - CONFIRM_EMAIL
          - FEEDBACK_RELEASED_DAILY_NOTIFICATION
          - FEEDBACK_RELEASED_DAILY_NOTIFICATION_TO_MANAGERS
          - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NOTIFICATION
          - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NUDGE
          - FEEDBACK_REQUEST_INFORM_MANAGER_TO_NOMINATE
          - FEEDBACK_REQUEST_INSTRUCTION_REVIEWEE
          - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEEDBACK_MANAGER
          - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEED_BACK
          - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASING_FEED_BACK_SOON
          - FEEDBACK_REQUEST_NOTIFY_MANAGER_ABOUT_NOMINATIONS
          - FEEDBACK_REQUEST_NUDGE_MANAGER
          - FEEDBACK_REQUEST_NUDGE_REVIEWEE
          - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NOTIFICATION
          - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NUDGE
          - FEEDBACK_REQUEST_PARTICIPANT_DECLINED
          - FEEDBACK_REQUEST_PARTICIPANT_DECLINED__REVIEWEE
          - GUEST_INVITED
          - INFORM_MANAGER_ABOUT_NEW_REPORTS
          - MEETING_NUDGE
          - MESSAGE_CHANGED_BY_NON_AUTHOR
          - MESSAGE_NOTIFICATION
          - NOTIFY_ADMIN_TO_REVIEW_FEEDBACK_CYCLE_AFTER_REVIEWER_SELECTION_DEADLINE_PASSED
          - NUDGE_EMPLOYEE_TO_PROVIDE_SELF_ASSESSMENT
          - NUDGE_EMPLOYEE_TO_PROVIDE_SINGLE_FEEDBACK
          - OBJECTIVES_DUE
          - OBJECTIVES_NUDGE_EMPLOYEE
          - OBJECTIVES_NUDGE_EMPLOYEE_ABOUT_OBJECTIVE
          - OBJECTIVES_NUDGE_INITIAL
          - OBJECTIVES_NUDGE_MANAGER
          - OBJECTIVES_NUDGE_MANAGER_INITIAL
          - OBJECTIVE_UPDATE_FOR_MANAGER
          - OBJECTIVE_UPDATE_FOR_USER
          - PASSWORD_CHANGED
          - PASSWORD_CHANGE_INSTRUCTIONS
          - PASSWORD_RESET
          - PASSWORD_WELCOME_INSTRUCTIONS
          - PRAISE_CHANGED_BY_NON_AUTHOR
          - PRAISE_NOTIFICATION
          - PRAISE_NOTIFY_MANAGER
          - REVIEW_CHANGED_BY_MANAGER
          - REVIEW_CHANGED_BY_REVIEWEE
          - REVIEW_HID_BY_EMPLOYEE
          - REVIEW_HID_BY_MANAGER
          - REVIEW_INDICATED_BY_MANAGER
          - REVIEW_INFORM_CUSTOM_REVIEWER_UNSPECIFIC
          - REVIEW_INFORM_MANAGER_UNSPECIFIC
          - REVIEW_INFORM_SECONDARY_REVIEWER_NUDGE_MANAGER
          - REVIEW_INFORM_SECONDARY_REVIEWER_UNSPECIFIC
          - REVIEW_INFORM_TEAM_MEMBER
          - REVIEW_NUDGE_MANAGER
          - REVIEW_NUDGE_MANAGER_UNSPECIFIC
          - REVIEW_NUDGE_REPORT
          - REVIEW_NUDGE_SECONDARY_REVIEWER_UNSPECIFIC
          - REVIEW_SHARE_WITH_EMPLOYEE
          - REVIEW_SHARE_WITH_MANAGER
          - REVIEW_SIGNED_BY_MANAGER
          - REVIEW_SIGNED_BY_REPORT
          - SURVEY_NOTIFICATION
          - USER_DIGEST
          - USER_INVITED
          - USER_PROFILE_NUDGE
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/EmailTemplatePreview'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v2/companies/{companyId}/emails/{templateId}/dummyPreview:
    get:
      tags:
      - companies-email-templates-resource
      summary: renderDummyPreview
      operationId: renderDummyPreviewUsingGET
      parameters:
      - name: companyId
        in: path
        description: companyId
        required: true
        schema:
          type: string
      - name: templateId
        in: path
        description: templateId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/EmailTemplatePreview'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: true
  /v2/companies/{companyId}/emails/{templateId}/preview:
    get:
      tags:
      - companies-email-templates-resource
      summary: renderPreview
      operationId: renderPreviewUsingGET
      parameters:
      - name: companyId
        in: path
        description: companyId
        required: true
        schema:
          type: string
      - name: feedbackCycleId
        in: query
        description: feedbackCycleId
        required: false
        schema:
          type: string
      - name: reviewCycleId
        in: query
        description: reviewCycleId
        required: false
        schema:
          type: string
      - name: templateId
        in: path
        description: templateId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/EmailTemplatePreview'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: true
  /v2/companies/{companyId}/emails/{type}:
    get:
      tags:
      - companies-email-templates-resource
      summary: getModificationForType
      operationId: getModificationForTypeUsingGET
      parameters:
      - name: companyId
        in: path
        description: companyId
        required: true
        schema:
          type: string
      - name: type
        in: path
        description: type
        required: true
        schema:
          type: string
          enum:
          - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWEES
          - ANYTIME_FEEDBACK_DEADLINE_CHANGED_FOR_REVIEWERS
          - ANYTIME_FEEDBACK_INVITATION_ABOUT_OTHERS
          - ANYTIME_FEEDBACK_INVITATION_ABOUT_SELF
          - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_OTHERS
          - ANYTIME_FEEDBACK_REMINDER_FOR_REQUEST_ABOUT_SELF
          - ANYTIME_FEEDBACK_REQUESTED_ABOUT_YOU
          - ANYTIME_FEEDBACK_SELF_REFLECTION
          - ANYTIME_FEEDBACK_SHARED_WITH_REPORT
          - ANYTIME_FEEDBACK_SHARED_WITH_YOU
          - CONFIRM_EMAIL
          - FEEDBACK_RELEASED_DAILY_NOTIFICATION
          - FEEDBACK_RELEASED_DAILY_NOTIFICATION_TO_MANAGERS
          - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NOTIFICATION
          - FEEDBACK_REQUEST_APPROVEABLE_REVIEWS_NUDGE
          - FEEDBACK_REQUEST_INFORM_MANAGER_TO_NOMINATE
          - FEEDBACK_REQUEST_INSTRUCTION_REVIEWEE
          - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEEDBACK_MANAGER
          - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASED_FEED_BACK
          - FEEDBACK_REQUEST_NOTIFICATION_ABOUT_RELEASING_FEED_BACK_SOON
          - FEEDBACK_REQUEST_NOTIFY_MANAGER_ABOUT_NOMINATIONS
          - FEEDBACK_REQUEST_NUDGE_MANAGER
          - FEEDBACK_REQUEST_NUDGE_REVIEWEE
          - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NOTIFICATION
          - FEEDBACK_REQUEST_OUTSTANDING_REVIEWS_NUDGE
          - FEEDBACK_REQUEST_PARTICIPANT_DECLINED
          - FEEDBACK_REQUEST_PARTICIPANT_DECLINED__REVIEWEE
          - GUEST_INVITED
          - INFORM_MANAGER_ABOUT_NEW_REPORTS
          - MEETING_NUDGE
          - MESSAGE_CHANGED_BY_NON_AUTHOR
          - MESSAGE_NOTIFICATION
          - NOTIFY_ADMIN_TO_REVIEW_FEEDBACK_CYCLE_AFTER_REVIEWER_SELECTION_DEADLINE_PASSED
          - NUDGE_EMPLOYEE_TO_PROVIDE_SELF_ASSESSMENT
          - NUDGE_EMPLOYEE_TO_PROVIDE_SINGLE_FEEDBACK
          - OBJECTIVES_DUE
          - OBJECTIVES_NUDGE_EMPLOYEE
          - OBJECTIVES_NUDGE_EMPLOYEE_ABOUT_OBJECTIVE
          - OBJECTIVES_NUDGE_INITIAL
          - OBJECTIVES_NUDGE_MANAGER
          - OBJECTIVES_NUDGE_MANAGER_INITIAL
          - OBJECTIVE_UPDATE_FOR_MANAGER
          - OBJECTIVE_UPDATE_FOR_USER
          - PASSWORD_CHANGED
          - PASSWORD_CHANGE_INSTRUCTIONS
          - PASSWORD_RESET
          - PASSWORD_WELCOME_INSTRUCTIONS
          - PRAISE_CHANGED_BY_NON_AUTHOR
          - PRAISE_NOTIFICATION
          - PRAISE_NOTIFY_MANAGER
          - REVIEW_CHANGED_BY_MANAGER
          - REVIEW_CHANGED_BY_REVIEWEE
          - REVIEW_HID_BY_EMPLOYEE
          - REVIEW_HID_BY_MANAGER
          - REVIEW_INDICATED_BY_MANAGER
          - REVIEW_INFORM_CUSTOM_REVIEWER_UNSPECIFIC
          - REVIEW_INFORM_MANAGER_UNSPECIFIC
          - REVIEW_INFORM_SECONDARY_REVIEWER_NUDGE_MANAGER
          - REVIEW_INFORM_SECONDARY_REVIEWER_UNSPECIFIC
          - REVIEW_INFORM_TEAM_MEMBER
          - REVIEW_NUDGE_MANAGER
          - REVIEW_NUDGE_MANAGER_UNSPECIFIC
          - REVIEW_NUDGE_REPORT
          - REVIEW_NUDGE_SECONDARY_REVIEWER_UNSPECIFIC
          - REVIEW_SHARE_WITH_EMPLOYEE
          - REVIEW_SHARE_WITH_MANAGER
          - REVIEW_SIGNED_BY_MANAGER
          - REVIEW_SIGNED_BY_REPORT
          - SURVEY_NOTIFICATION
          - USER_DIGEST
          - USER_INVITED
          - USER_PROFILE_NUDGE
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/EmailTemplateModificationInfo'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
components:
  schemas:
    EmailTemplatePreview:
      type: object
      title: EmailTemplatePreview
    EmailTemplateModificationInfo:
      type: object
      title: EmailTemplateModificationInfo
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Personal access token generated from user profile settings