Zum Hauptinhalt springen
Communities are membership groups that gate access to resources and services. Members can receive booking quotas, access control grants, and exclusive booking permissions. For general conventions, see JSON-API Conventions. For authentication, see Authentication.

Prerequisites

  • Admin API: Bearer token with admin access + ?o={organization_id}
  • Customer API: Authenticated customer account for membership and invite actions

Concepts

Member Roles

Member Statuses

Memberships can be time-limited via start_date and end_date fields on the community account.

Creating a Community (Admin)

Key Attributes

The three booking rules apply to members who may book, on the services the community covers. If a customer’s communities disagree, the most permissive value wins: allowed, the shortest lead time, the longest period. Admin bookings keep the service settings. For customers, the service’s lead_time and allow_recurring attributes already show the value that applies to them. GET /api/v1/communities?o={org_id}&filter[covers_service]={service_id} lists communities that grant a service through include_all_services, because the service is offered on a resource they cover. These communities have no direct link to the service.

Resource meta

Authenticated community resource objects (primary and included) expose:
Listing membership rows (community-accounts) is a different endpoint and is not how this count is produced.

Inviting Members (Admin)

Send email invitations to join:
If an email matches an existing customer account, the membership is created immediately (no pending invite). A second invite to the same email widens the existing pending invite instead of creating another row. Booking auto-join reuses an overlapping or covering membership and consumes leftover pending invites for that email, so the members page does not list the same person as both invite and member. Non-overlapping sequential windows (for example two separate week-long visits) still create separate memberships.

List invitations

Allowed sort: email, created_at, accepted_at. Allowed include: community, user, organization, organization.logo_image, joined_through.

Resend an Invitation


Auto-Join Rules

Communities can automatically add members based on: Configure via the auto_join_settings attribute on the community resource. Use the sync endpoint to apply rules retroactively:
Returns the number of newly added members.

Customer Membership Actions

Community membership actions are documented in the customer API, not the public API.

Leave a Community

Accept an Invite


Common Errors