Introduction

What the Community API is and how to read these docs.

Create, read, update and remove the people subscribed to your community.

Every response is JSON, every identifier is an opaque string, and every non-2xx
response uses one error envelope. Times are RFC 3339 in UTC.

Base URL

https://api.community.com

There is no version segment in the path. The API version is pinned to your
token's creation date, and a single request can override it with the
Community-Version header by passing the version. See
Versioning.

Compatibility

New fields, new endpoints and new error codes arrive without a version bump, so
parse leniently:

  • Ignore fields you do not recognise rather than failing on them.
  • Treat an unrecognised error code as its type.
  • Never parse an identifier. They are opaque strings, and their encoding may
    change per object type.