API Details

From Charitylog Manual
Jump to: navigation, search
Helpheader small.png

The API enables technical users capable of writing their own applications to integrate with their Charitylog or Crossdata instance without having to log in to the web interface. It is a RESTful API using JSON over https. For prices, please call the office. To enable API users please see Users.

General Concepts


API Dictionaries

API Authentication

API Entities

The API is based around various entities. To avoid breaking changes, the names in the API are fixed. If you are a developer talking to end users, it's useful to know that many features have different names in the web application, particular because many features can be renamed by a local admin.

API name Description Renamable in web app? Typical names in web app
classification_codes A tiered coding system used to classify done_contacts Y Classification code, enquiry codes
clients Organisations/people that are people, e.g. clients, staff volunteers etc. Y Clients, Service Users, Staff, Volunteers
done_contacts Completed actions N Contacts
due_contacts Outstanding actions that typically make up the Action List in the web application N Outstanding actions
extension_databases Used to create your own data structures for forms etc N Extension Databases
external_referrals Referrals collected externally, e.g. a self-referral form on your website N Inbound Referrals
project A service your organisation provides Y Project, Service, Department
referrals Groups of done_contacts and due_contacts Y Referrals, Cases, Enquiries
relationship_details Relationships between 2 people, e.g. parent, social worker, carer etc N Relationships
schedules Roster job cards N Jobs cards is not renamable, but the workers are, e.g. Home Helper Job Cards, Support Worker Job Cards etc
stage A stage on a template, e.g. Initial Assessment N Stage
status A broad grouping of a stage, e.g. Being Supported, Not For Reports etc N Status
template A workflow, e.g. a collection of stages to guide you through a case N Template
workers People who work on schedules Y Home Helpers, Support Workers, Carers


File Uploads

Reading data (GETs)

API Filters

Selecting Specific Fields

Running Reports

Writing data (POSTs and PUTs)

Creating Records

Updating Records

External Referrals

Making the most of your data

Getting Started with Power Query with Excel

Getting Started with Power Query in Power BI Desktop

How to achieve more with Power Query

Purchasing and getting started


Working with existing API partners

Sample Calls