Canopy User Tags API
The User Tags API from Canopy — 2 operation(s) for user tags.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/canopyservicing-com:canopyservicing-com-user-tags-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Canopy Servicing Core User 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: User Tags
paths:
/core/v1/tags:
get:
tags:
- User Tags
summary: Get all tags for the organization
description: Gets all user generated tags for the organization.
operationId: TagsCBV_get_all_tags_core_v1_tags_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/TagWithCountSchema'
type: array
title: Response Tagscbv Get All Tags Core V1 Tags Get
'500':
description: A server error has occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrServerErrorSchema'
security:
- HTTPBearer: []
post:
tags:
- User Tags
summary: Add tag to the organization
description: Adds a new user generated tag to the organization.
operationId: TagsCBV_create_tag_option_core_v1_tags_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TagSchema'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TagSchema'
'400':
description: Your request is invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrBadRequestSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'500':
description: A server error has occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrServerErrorSchema'
security:
- HTTPBearer: []
/core/v1/tags/{tag_id}:
patch:
tags:
- User Tags
summary: Update a tag option
description: Updates a user generated tag option.
operationId: TagsCBV_update_tag_option_core_v1_tags__tag_id__patch
security:
- HTTPBearer: []
parameters:
- name: tag_id
in: path
required: true
schema:
type: string
description: ID of the tag
title: Tag Id
description: ID of the tag
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTagRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TagSchema'
'400':
description: Your request is invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrBadRequestSchema'
'404':
description: Entity not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrNotFoundSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'500':
description: A server error has occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrServerErrorSchema'
components:
schemas:
TagSchema:
properties:
tag_id:
type: integer
title: Tag Id
description: The unique identifier of the tag
examples:
- 1
label:
type: string
title: Label
description: The label of the tag
examples:
- Risk review
description:
type: string
title: Description
description: The description of the tag
examples:
- Risky accounts
color:
$ref: '#/components/schemas/TagColor'
description: The color of the tag
examples:
- red
active:
type: boolean
title: Active
description: The active status of the tag
examples:
- true
type: object
required:
- label
- description
- color
title: TagSchema
description: Base response schema for surfacing tag information to the user.
ErrBadRequestSchema:
properties:
message:
type: string
title: Message
description: The error message
examples:
- Your request is invalid.
type: object
required:
- message
title: ErrBadRequestSchema
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
UpdateTagRequest:
properties:
description:
type: string
title: Description
description: The new description for the tag
color:
$ref: '#/components/schemas/TagColor'
description: The new color for the tag
active:
type: boolean
title: Active
description: The new active status for the tag
additionalProperties: false
type: object
title: UpdateTagRequest
description: Schema for the request body when updating a tag
ErrNotFoundSchema:
properties:
message:
type: string
title: Message
description: The error message
examples:
- Entity not found.
type: object
required:
- message
title: ErrNotFoundSchema
ErrServerErrorSchema:
properties:
message:
type: string
title: Message
description: The error message
examples:
- A server error has occurred.
type: object
required:
- message
title: ErrServerErrorSchema
TagColor:
type: string
enum:
- red
- orange
- yellow
- green
- blue
- purple
- pink
- sky
- teal
- gray
- black
title: TagColor
description: Enum for the colors of tags.
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
TagWithCountSchema:
properties:
tag:
$ref: '#/components/schemas/TagSchema'
account_tag_count:
type: integer
title: Account Tag Count
type: object
required:
- tag
title: TagWithCountSchema
description: 'Enhanced response schema for surfacing tag information to the user
when needing to include the count of how many accounts have the tag.'
securitySchemes:
HTTPBearer:
type: http
scheme: bearer