Canopy System Tags API

openapi: 3.2.0
info:
  title: Canopy Servicing Core System Tags API
  description: 'Canopy allows you to easily manage credit, installment, or other more complex lending programs from a servicing and compliance perspective -

    whether newly launched or migrated from existing systems. using canopy, you can track balances and transactions for each customer of your product, both in real-time and historically.

    You can see how various policy and product changes would impact your customers, and readily generate compliance reports and minimize your risk with all real-time information always on hand.

    Canopy additionally surfaces information around all of your lending activity through its intuitive ui which provides a customer support interface as well as at-a-glance data needed for compliance and insights.

    Simply configure your product`s policies through our create product api endpoint, and then you can immediately begin adding customer accounts and relying on canopy for accurate servicing information.'
  contact:
    name: Canopy Support
    url: https://www.canopyservicing.com/contact
    email: support@canopyservicing.com
  version: 1.0.0
servers:
- url: Contact sales to enable your sandbox
  description: Your private sandbox environment
- url: https://demo-api.us.canopyservicing.com
  description: Demo environment
tags:
- name: System Tags
  description: Tags that are automatically applied to accounts based on certain criteria.
paths:
  /core/v1/system_tags:
    get:
      tags:
      - System Tags
      summary: Get all system applied tags
      description: Gets all system applied tags available in the LMS.
      operationId: SystemTagsCBV_get_all_system_applied_tags_core_v1_system_tags_get
      responses:
        '200':
          description: Returns a list of tags that are automatically applied to accounts when they meet certain criteria.
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/GetSystemTagResponse'
                type: array
                title: Response Systemtagscbv Get All System Applied Tags Core V1 System Tags Get
        '500':
          description: A server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrServerErrorSchema'
      security:
      - HTTPBearer: []
components:
  schemas:
    ErrServerErrorSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - A server error has occurred.
      type: object
      required:
      - message
      title: ErrServerErrorSchema
    TagCategory:
      type: string
      enum:
      - COLLATERAL_LIQUIDATION
      - CREDIT_UTILIZATION
      - DELINQUENCY_BUCKETS
      - DISPUTE_STATUS
      - GRADUATION
      - MISSED_PAYMENT
      - PAYMENT_DEFERRAL
      - PERSISTENT_DEBT
      - TEST_CATEGORY
      title: TagCategory
    TagColor:
      type: string
      enum:
      - red
      - orange
      - yellow
      - green
      - blue
      - purple
      - pink
      - sky
      - teal
      - gray
      - black
      title: TagColor
      description: Enum for the colors of tags.
    GetSystemTagResponse:
      properties:
        tag_id:
          type: integer
          title: Tag Id
          description: The ID of the tag
          examples:
          - 1
        label:
          type: string
          title: Label
          description: The label of the tag
          examples:
          - 1-30 days delinquent
        description:
          type: string
          title: Description
          description: The description of the tag
          examples:
          - Customer is in the 1-30 days delinquency bucket.
        color:
          $ref: '#/components/schemas/TagColor'
          description: The color of the tag
          examples:
          - yellow
        category:
          $ref: '#/components/schemas/TagCategory'
          description: The category of the tag
          examples:
          - DELINQUENCY_BUCKETS
        active:
          type: boolean
          title: Active
          description: The active status of the tag
          examples:
          - true
      type: object
      required:
      - tag_id
      - label
      - description
      - color
      - category
      - active
      title: GetSystemTagResponse
      description: Response schema for the get system tags endpoint.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer