Skip to main content
A red haired man wearing a cream colored sweater shakes hands with a brunette woman wearing a tan turtleneck as other coworkers look on and a corkboard with posted notes in the background

Sharing and Transforming Data
with the iCarol API

A red haired man wearing a cream colored sweater shakes hands with a brunette woman wearing a tan turtleneck as other coworkers look on and a corkboard with posted notes in the background

Sharing and Transforming Data with the
iCarol API

At iCarol, it’s one of our deeply held beliefs that your data belongs to you.

It is part of our mission and stewardship of that data to help you harness it to do more good in your community, provide continuity of care to people in need, and enhance your relevance and marketability as a community partner and vital provider of services.

iCarol Application Program Interface (API) solutions offer the ultimate versatility for your data sharing initiatives.

hand holding a mobile phone with apps appearing on the mobile phone screen

What is an API?

API stands for Application Programming Interface, and it allows electronic systems to interact with each other without the need for direct human intervention.

With an API, no person needs to direct data traffic between two systems — the systems just talk directly to each other behind the scenes. APIs are a leading way for our customers to harness their data and open up new avenues for partnerships and revenue streams.

API Solutions in iCarol

Contact Record API

The Contact Record API provides a way for you to take the data from any consumer interaction submitted in a Contact Record and push it to an awaiting “restful API web service” or “webhook.” Once a Contact Record is created in your iCarol system, your partners can also use the API to update those Contact Records with additional data they may have to contribute, such as outcomes, updates on client status, and more.

solid icon of a file and pen

Common Contact Record API Use Cases:

  • Send data you collect to a funder or partner’s software as part of your contracted service
  • Send data you collect in specific forms, such as intake forms, when contracted to provide a service for an entity such as a hospital, insurer, mobile crisis team, or other service provider
  • Send data to collaborative reporting systems or dashboards for trend analysis, and data-driven community planning to influence public policy

Resource API

This API capability makes it easy for you to access your live iCarol data in your resource or service provider database in ways never before possible.

The bidirectional capability of the iCarol Resource API means you can not only share outbound resource data from your iCarol system, but authorized external systems can create new resource records or allow updates to your existing resource records as well. With the API, authorized partners can update their listing in your database using their own technology, avoiding the need for imports or other manual data entry.

book icon

Common Resource API Use Cases:

  • Develop mobile apps for iPhone, iPad, Android and other devices to let members of the public find nearby services
  • Create custom-built websites that let the public search and view data from your Resource Database in ways that your programmers can utterly customize, for instance to target certain populations or design a specific presentation
  • Partner with other organizations to contribute resource information to their database — collaborations that are often revenue generators

Questions about using the iCarol API at Your Organization? Let’s Talk!