Skip to main content
Beta

Get started with the Communal API

Three steps to your first API call. The Communal Platform API is in beta, using standard REST conventions, Bearer authentication, and JSON responses, so you can start building with any HTTP client.

1

Get API access

Contact Communal through a demo or your account representative to request API credentials. Your team will receive access tokens scoped to your organization's data and the environments you need.

2

Authenticate your requests

Add your access token to the Authorization header as a Bearer token. All API requests require authentication. There are no public endpoints.

curl -H "Authorization: Bearer your_access_token" \
  https://api.getcommunal.com/api/membership_types
3

Make your first request

Start by listing resources you already know, like your organization's membership types or upcoming programs. The response includes data, meta (pagination), and links for navigating results.

{
  "data": [
    {
      "id": 1,
      "type": "membership_type",
      "attributes": { ... }
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 42
  },
  "links": {
    "next": "https://api.getcommunal.com/api/..."
  }
}

Authentication

The Communal API uses HTTP Bearer authentication. Include your access token in the Authorization header with every request. 

Authorization: Bearer your_access_token

Token security best practices

  • Store tokens in your secrets management system, not in code
  • Keep tokens server-side. Never embed them in client-side apps or public repositories
  • Rotate tokens when team members leave or roles change

API at a glance

Key facts about the Communal Platform API.

Status
Currently in beta. Endpoints are actively expanding and we work closely with early adopters to prioritize what's next.
Protocol
REST over HTTPS with JSON request and response bodies
Specification
OpenAPI 3.1. Use with codegen tools, API clients, or doc viewers.
Authentication
HTTP Bearer tokens in the Authorization header
Base URL
https://api.getcommunal.com/api
Available endpoints
Programs, registration opportunities, program signups, membership types, membership cards, attendance sheets, attendance records, card delivery activities, and user updates
Pagination
Cursor-based pagination with data, meta, and links in every list response
Error handling
Standard HTTP status codes (200, 401, 403, 404, 422, 500) with JSON error details

Explore the full API documentation

The complete API reference with endpoint details, request and response examples, and the OpenAPI specification is available at our documentation site.

Visit docs.getcommunal.com

Need API access?

Book a demo to discuss API credentials, scopes, and the right integration approach for your organization.

Book a free demo