Getting started

This guide walks you through your first successful call to the Communal Platform API.

Prerequisites

A Communal account for your organization.
An API key from My profile → API keys in Communal. Managers can also issue a key for any user from People → Users. See Authentication for details.

Base URL

All examples below use production:

https://api.getcommunal.com/api

Path segments in the reference are relative to that base (for example, GET /parent_programs becomes GET https://api.getcommunal.com/api/parent_programs).

Make your first request

List parent programs for your organization:

curl -sS -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.getcommunal.com/api/parent_programs"

Replace YOUR_API_KEY with the secret from My profile → API keys.

How to explore further

Using the API — pagination, filters, include / sort, and common errors.
API Reference — try requests and inspect schemas for every path.

Overview

Authentication