Communal Platform API
​integer · required​string​string​string
Properties for Variant 1:​integer · required​string · required​string · required​string[] · required​string | null · required​string | null · required​string | null · required​string | null · required​string | null · required​string | null · required​boolean · required​boolean · required​string | null · required​string | null · required​string | null · required​string | null · required​string | null · required​string | null · required​boolean · required​string | null · required​integer | null · required​string | null · date-time · required​boolean · required​boolean · required​boolean · required​boolean · required​boolean · required​boolean · required​integer | null · required​boolean · required​integer | null · required​string | null · required​string | null · required​integer | null · required​string · required​string | null · required​string | null · required​boolean · required
​string · required​string​string · maxLength: 255 · required​string · maxLength: 255 · required​string · email · required​string | null​string | null · maxLength: 255​string | null · maxLength: 255​string | null · date-time​string | null​string | null​string | null​string | null​string | null​string | null​string | null​integer · required​integer | null · required​string · required​string | null · required​string | null · required​string | null · required​string | null · required​string | null · date-time · required​string · required​boolean · required​boolean · required​string | null · required​boolean · required​integer | null · required​string | null · required​string | null · required​string | null · required​string | null · required​string | null · date-time · required​string | null · required​string | null · date-time · required​string | null · date-time · required​string | null · required​string | null · required​string | null · required​string | null · required​string | null · required​string | null · required​string | null · required​integer | null · required​boolean · required​string | null · required​integer · required​string | null · required​string | null · required​string | null · date-time · required​string | null · required​string | null · required​string | null · required​integer | null · required​boolean · required​boolean · required​string | null · required​string | null · date-time · required​string | null · required​integer | null · required​string | null · required​string · enum · required​boolean · required​null · required​null · required​null · required​(string | null)[] · required
Show a user
GET
https://api.getcommunal.com/api
/users/{user}
path Parameters
userquery Parameters
includeInclude related data. Options: card, family, roles,permissions, files.
filter[tenant_id]For parent tenants, optionally show users from a child tenant or all visible child tenants.
Headers
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
Show a user › Responses
UserResource
anyOf
At least one variant must match. Multiple variants may match simultaneously.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: id, name, email +41 more | |
| type = object · requires: id, name, email +14 more | |
| type = object · requires: data |
idnameemailsubscriptionsprofile_addressprofile_address_line_2profile_cityprofile_stateprofile_zipprofile_country​TimeslotSignup[] · required
​TimeslotSignup[] · required
managertwo_factor_enabledfirst_namelast_namemiddle_namepreferred_nametelephonebusiness_namecan_impersonate​UserRole[] · required
member_idaccount_idcreated_atrequires_password_resetrequire_address_in_complete_your_profilerequire_registration_form_in_complete_your_profilehas_registration_form_submissionhas_completed_profilehas_complete_your_profile_settingstenant_idis_family_sub_accountfamily_group_holder_idprofile_photo_urlinvoice_number_prefixinvoice_number_starting_atstripe_customer_urlcard_idcardcan_use_card​Family[] · required
​Permission[] · required
​UserUploadedFile[] · required
Update a user
PUT
https://api.getcommunal.com/api
/users/{user}
Performs an user update request.
path Parameters
userHeaders
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
Update a user › Request Body
first_nameThe first name of the user.
last_nameThe last name of the user.
emailA unique email address for the user.
nameThe full name of the user (generated from first/last name).
middle_nameThe middle name of the user.
preferred_nameThe preferred name of the user.
date_of_birthThe date of birth of the user.
profile_cityThe city of the user.
profile_zipThe postal code or zip code of the user.
profile_stateThe province or state of the user.
profile_addressThe street address of the user.
profile_address_line_2The second line of the address of the user.
profile_countryThe ISO 3166-1 alpha-2 country code of the user.
telephoneA phone number for the user.
​object
Update a user › Responses
User
idtenant_idnamefirst_namelast_namemiddle_namepreferred_namedate_of_birthemailemail_lockedrequires_password_resetphoto_urluses_two_factor_authcurrent_team_idstripe_idcurrent_billing_planbilling_statevat_idtrial_ends_atlast_read_announcements_atcreated_atupdated_atwork_phoneprofile_addressprofile_address_line_2profile_cityprofile_stateprofile_zipprofile_countryfamily_idmanagerplaces_idstatustelephonetimezonedeleted_timestampmember_idcard_idbusiness_nameaccount_idcan_use_cardis_communal_adminreferreranonymized_atinvoice_number_prefixinvoice_number_starting_atprofile_photo_pathactiveEnum values:
Active
Inactive
two_factor_enabledbase_membership_planmembership_start_datereadable_membership_start_date​required
addon_membership_plans