Skip to content

Knowledge base/API

API v1.0

Jan 12

This document describes the v1 API of Currinda. This API is focused on the accessing of resources pertaining to associations/organisations within the Currinda database. For the user authentication, v0.1 is still the only method.

API Access

API Access is controlled by each Currinda site. Each client will provide OAuth Client ID and Client Secret information.

URLs

All URLs in this document are based on the root domain of the site. This is usually in the format https://{currinda_site}.currinda.com/

Authentication

Authentication to the api is through the client credentials OAuth2 grant type.

GET /api/v1/organisation/{organisation_id}/token

This is the token endpoint. Requests to this with a valid client id and secret will return the necessary authorization code.

Resources

List memberships in Organisation

GET /api/v1/organisation/{organisation_id}/members

Parameters: MembershipType[] (array), OrganisationChapter[] (array), FinancialStatus[] (array, default: financial — financial, expired, expiring, outstanding), ExpiryDate[To] (datetime), ExpiryDate[From] (datetime), CurrentAddons[] (array), Searchable (boolean).

List membership types in Organisation

GET /api/v1/organisation/{organisation_id}/membershiptypes

Parameters: Visible (boolean, default: true), Searchable (boolean).

List addons in Organisation

GET /api/v1/organisation/{organisation_id}/addons

Parameters: Visible (boolean, default: true), Searchable (boolean).