Integrate with ClientPoint
using
the CustomerOS® API
ClientPoint's "Customer Operating System" (CustomerOS®) seamlessly integrates a wide array of popular B2B SaaS offerings and data streams, to help create a simple, cohesive and intuitive online business relationship layer between a company and each of its prospects, partners, customers and other key constituents.
A ClientPoint® is the place that a company and its customers gather together, through a simple URL from any Internet-connected device, to perform all sales, support, communication and collaboration functions to allow every relationship to form, grow and thrive. In this way, a ClientPoint, powered by CustomerOS, becomes the universal online access point for a company to optimally serve all of its relationships in this increasingly remote, deskless world.
ClientPoint's API Documentation
The ClientPoint API documentation is organized into three main sections:
Enterprise API Endpoints
Enterprise Webhooks
Customer OS
-
Enterprise API Endpoints: This section provides detailed information about the HTTP
endpoints available for developers to interact with ClientPoint's Enterprise APIs. We offer the
following endpoints:
- Analytics
- Analytics: This endpoint returns all ClientPoint Analytics
- ClientPoint Files: This endpoint returns ClientPoint Files Analytics
- Library Files: This endpoint returns Library Files Analytics
- Custom Fields: This endpoint returns Custom Fields Analytics
- Viewed Sessions: This endpoint returns all Viewed Sessions Analytics
- Signed ClientPoints: This endpoint returns Signed ClientPoints Analytics
- OnePass Form Fields: This endpoint returns OnePass Form Fields data
- ClientPoint Users: This endpoint returns ClientPoint Users data
- Automation
- Create ClientPoint: This endpoint allows you to create a new ClientPoint
- Update ClientPoint: This endpoint allows you to update an existing ClientPoint
- Approve ClientPoint: This endpoint allows you to approve a ClientPoint
- ClientPoint Notes: This endpoint allows you to add notes to a ClientPoint
- Upload a File: This endpoint allows you to upload a local file from your system
- Document Generation: This endpoint allows you to generate a ClientPoint merged document
- Add Link: This endpoint allows you to add a link to a ClientPoint
- Delete File: This endpoint allows you to delete a file from a ClientPoint
- Get ClientPoint Links: This endpoint returns ClientPoint customer links
- Download ClientPoint File: This endpoint allows you to download a file from a ClientPoint
- Products Export: This endpoint allows you to export ClientPoint Products
- Snippets Export: This endpoint allows you to export ClientPoint Snippets
- Fragments Export: This endpoint allows you to export ClientPoint Fragments
- Add Recipient: This endpoint allows you to add or update a recipient
- Delete Recipient: This endpoint allows you to delete a recipient
- Analytics
- Enterprise Webhooks: ClientPoint webhooks allow you to receive instant notifications when specific events occur, helping you automate workflows without needing constant API requests. To automate your workflow using webhooks, please reach out to the ClientPoint team. Read More
-
CustomerOS:
-
CustomerOS BI: This section provides detailed information about the HTTP endpoints available for developers to interact dynamically with ClientPoint's CustomerOS BI APIs. These endpoints enable seamless access to real-time analytics, reporting, and business intelligence data to optimize decision-making and performance.
- Analytics: Access comprehensive relationship analytics
- Health: Monitor relationship health metrics
- License: Manage relationship licenses
- People: Access relationship people data
- Relationships: Manage business relationships
- Relationship Posts: Access relationship post data
- Groups: Manage relationship groups
- Group Posts: Access group post data
- Post Comments: Manage post comments
- Post Attachments: Access post attachments
-
CustomerOS for Websites: This section explains how CustomerOS integrates with websites, enabling seamless user engagement, lead generation, and dynamic content personalization to enhance the online customer experience.
- How to install & use: Step-by-step guide for website integration
-
CustomerOS BI: This section provides detailed information about the HTTP endpoints available for developers to interact dynamically with ClientPoint's CustomerOS BI APIs. These endpoints enable seamless access to real-time analytics, reporting, and business intelligence data to optimize decision-making and performance.
By following the documentation, developers can build robust integrations that leverage the full power of ClientPoint's API.
Integration guides
If you're new to ClientPoint's platform or want to understand how our API works before making your first API call, you can check out the Overview & EndPoint section located underneath every API endpoint. This section provides detailed information about each API endpoint, including the endpoint URL, API type, Request body, and Authentication requirements. You can also run API calls directly from this API portal, allowing you to test out the endpoints and get a better sense of how they work.