Canopy Organizations API

Manage organizations in Canopy.

Operations 5

GET /core/v1/organizations Get all organizations #
GET /core/v1/organizations/data_direct Gets the Data Direct connection configuration #
GET /core/v1/organizations/data_direct/allow_list Gets the Data Direct allow list #
POST /core/v1/organizations/data_direct/allow_list Adds CIDRs to the Data Direct allow list #
DELETE /core/v1/organizations/data_direct/allow_list Deletes CIDRs from the Data Direct allow list #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/canopyservicing-com:canopyservicing-com-organizations-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

canopyservicing-com-organizations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Canopy Servicing Core Organizations 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: Organizations
  description: Manage organizations in Canopy.
paths:
  /core/v1/organizations:
    get:
      tags:
      - Organizations
      summary: Get all organizations
      description: Gets all organizations.
      operationId: OrganizationCBV_get_organizations_core_v1_organizations_get
      responses:
        '200':
          description: Returns a list of organizations
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/GetOrganizationResponse'
                type: array
                title: Response Organizationcbv Get Organizations Core V1 Organizations Get
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrForbiddenSchema'
        '500':
          description: A server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrServerErrorSchema'
      security:
      - HTTPBearer: []
  /core/v1/organizations/data_direct:
    get:
      tags:
      - Organizations
      summary: Gets the Data Direct connection configuration
      operationId: DataDirectCBV_get_data_direct_connection_core_v1_organizations_data_direct_get
      responses:
        '200':
          description: Returns the Data Direct connection configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDataDirectConnectionResponse'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrForbiddenSchema'
        '500':
          description: A server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrServerErrorSchema'
      security:
      - HTTPBearer: []
  /core/v1/organizations/data_direct/allow_list:
    get:
      tags:
      - Organizations
      summary: Gets the Data Direct allow list
      description: Gets the Data Direct allow list.
      operationId: DataDirectCBV_get_data_direct_allow_list_core_v1_organizations_data_direct_allow_list_get
      responses:
        '200':
          description: Returns a list of CIDRs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowListResponse'
        '400':
          description: Your request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrBadRequestSchema'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrForbiddenSchema'
        '500':
          description: A server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrServerErrorSchema'
      security:
      - HTTPBearer: []
    post:
      tags:
      - Organizations
      summary: Adds CIDRs to the Data Direct allow list
      description: Adds CIDRs to the Data Direct allow list.
      operationId: DataDirectCBV_add_cidrs_to_allow_list_core_v1_organizations_data_direct_allow_list_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddCidrRequest'
        required: true
      responses:
        '200':
          description: Returns 200 OK on success
          content:
            application/json:
              schema: {}
        '400':
          description: Your request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrBadRequestSchema'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrForbiddenSchema'
        '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: []
    delete:
      tags:
      - Organizations
      summary: Deletes CIDRs from the Data Direct allow list
      description: Deletes CIDRs from the Data Direct allow list.
      operationId: DataDirectCBV_delete_cidrs_from_allow_list_core_v1_organizations_data_direct_allow_list_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteCidrRequest'
        required: true
      responses:
        '200':
          description: Returns success status
          content:
            application/json:
              schema: {}
        '400':
          description: Your request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrBadRequestSchema'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrForbiddenSchema'
        '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: []
components:
  schemas:
    Cidr:
      properties:
        cidr:
          type: string
          title: Cidr
          description: The CIDR block
          examples:
          - 192.168.1.0/24
          hidden: false
        description:
          type: string
          title: Description
          description: The description of the CIDR rule
          examples:
          - My CIDR block
          hidden: false
      type: object
      required:
      - cidr
      - description
      title: Cidr
      description: CIDR model for an entry in the allow list.
    ErrBadRequestSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Your request is invalid.
      type: object
      required:
      - message
      title: ErrBadRequestSchema
    GetOrganizationResponse:
      properties:
        organization_id:
          type: integer
          title: Organization Id
          description: The organization ID.
          examples:
          - 1000
        name:
          type: string
          title: Name
          description: The name of the organization.
          examples:
          - Acme Corporation
        is_super_admin:
          type: boolean
          title: Is Super Admin
          description: Whether the organization is a super admin organization.
          examples:
          - true
      type: object
      required:
      - organization_id
      - name
      - is_super_admin
      title: GetOrganizationResponse
    ErrForbiddenSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Forbidden.
      type: object
      required:
      - message
      title: ErrForbiddenSchema
    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
    DeleteCidrRequest:
      properties:
        cidrs:
          items:
            type: string
          type: array
          title: Cidrs
          description: List of CIDR blocks or IP addresses to delete from the allow list
          examples:
          - - 123.456.789.012/32
            - 123.456.0.0/16
          hidden: false
      type: object
      required:
      - cidrs
      title: DeleteCidrRequest
      description: 'Request model for deleting CIDRs or IP addresses from the Data Direct allow list.

        IP addresses will automatically have /32 appended for convenience.'
    GetDataDirectConnectionResponse:
      properties:
        host:
          type: string
          title: Host
          description: The host of the Data Direct connection.
          hidden: false
        password:
          type: string
          title: Password
          description: The password of the Data Direct connection.
          hidden: false
        port:
          type: integer
          title: Port
          description: The port of the Data Direct connection.
          hidden: false
        username:
          type: string
          title: Username
          description: The username of the Data Direct connection.
          hidden: false
        database:
          type: string
          title: Database
          description: The database of the Data Direct connection.
          default: data_direct
          hidden: false
      type: object
      required:
      - host
      - password
      - port
      - username
      title: GetDataDirectConnectionResponse
      description: Response model for the Data Direct connection configuration.
    AddCidrRequest:
      properties:
        cidrs:
          items:
            $ref: '#/components/schemas/Cidr'
          type: array
          title: Cidrs
          description: List of CIDR blocks or IP addresses to add to the allow list
          examples:
          - - cidr: 123.0.0.123/32
              description: My IP address
            - cidr: 123.0.0.0/16
              description: Managed service address space
          hidden: false
      type: object
      required:
      - cidrs
      title: AddCidrRequest
      description: 'Request model for adding CIDRs or IP addresses to the Data Direct allow list.

        IP addresses will automatically have /32 appended for convenience.'
    AllowListResponse:
      properties:
        cidrs:
          items:
            $ref: '#/components/schemas/Cidr'
          type: array
          title: Cidrs
          description: List of CIDR blocks in the allow list
          examples:
          - - cidr: 123.0.0.123/32
              description: My IP address
            - cidr: 123.0.0.0/16
              description: Managed service address space
          hidden: false
      type: object
      required:
      - cidrs
      title: AllowListResponse
      description: Response model for the Data Direct allow list.
    ErrServerErrorSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - A server error has occurred.
      type: object
      required:
      - message
      title: ErrServerErrorSchema
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer