Project

carehq

0.0
The project is in a healthy, maintained state
CareHQ API client for Ruby.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Runtime

~> 0.20.0
 Project Readme

CareHQ Ruby API client

CareHQ API Client for Ruby.

Install

gem install carehq

Requirements

  • Ruby 2.3.0 or higher
  • httparty

Usage

require 'carehq'

api_client = APIClient.new(
    'MY_ACCOUNT_ID',
    'MY_API_KEY',
    'MY_API_SECRET'
)

users = api_client.request(
    'get',
    'users',
    params: {
        'attributes' => [
            'first_name',
            'last_name'
        ],
        'filters-q' => 'ant'
    }
)

Changelog

  • 2025-01-07: Updated to use the new 'CareHQ-Signature-Version 2.0' hashing mechanism (SHA256 with a nonce).