User

Server

Show a user

GET

http://api.community-management.test/api

/users/{user}

Show a user › path Parameters

user

integer · required

Show a user › query Parameters

include

string

Include related data. Options: card, family, roles,permissions, files.

filter[tenant_id]

string

For parent tenants, optionally show users from a child tenant or all visible child tenants.

Show a user › Headers

X-Api-Version

string

Optional 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

UserResource

id

string · required

name

string · required

email

string · required

date_of_birth

string | null · required

telephone

string

first_name

string

middle_name

string

last_name

string

preferred_name

string

created_at

string | null

updated_at

string | null

subscriptions

string

FamilyMember[]

GET/users/{user}

curl http://api.community-management.test/api/users/:user \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "id",
  "name": "name",
  "email": "email",
  "telephone": "telephone",
  "first_name": "first_name",
  "middle_name": "middle_name",
  "last_name": "last_name",
  "preferred_name": "preferred_name",
  "date_of_birth": "date_of_birth",
  "created_at": "created_at",
  "updated_at": "updated_at",
  "subscriptions": "subscriptions",
  "family": [
    {
      "id": 45,
      "user_id": 89,
      "invited_user_id": 91,
      "guest_id": null,
      "name": "Sarah Doe",
      "email": "sarah.doe@example.com",
      "telephone": "555-987-6543",
      "gender": "Female",
      "date_of_birth": "2015-03-15",
      "age": 10,
      "allergies": "Peanut allergy",
      "medical": "Carries an EpiPen. No other conditions.",
      "primary": false,
      "pending_invite": true,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-20T14:45:00.000000Z",
      "deleted_at": "2025-01-25T12:00:00.000000Z",
      "emergency": {
        "id": 0,
        "family_id": 0,
        "name": "name",
        "telephone": "telephone",
        "created_at": "2024-08-25T15:00:00Z",
        "updated_at": "2024-08-25T15:00:00Z"
      }
    }
  ]
}

json

application/json

Update a user

PUT

http://api.community-management.test/api

/users/{user}

Performs an user update request.

Update a user › path Parameters

user

string · required

Update a user › Headers

X-Api-Version

string

Optional 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_name

string · maxLength: 255 · required

The first name of the user.

last_name

string · maxLength: 255 · required

The last name of the user.

email

string · email · required

A unique email address for the user.

name

string | null

The full name of the user (generated from first/last name).

middle_name

string | null · maxLength: 255

The middle name of the user.

preferred_name

string | null · maxLength: 255

The preferred name of the user.

date_of_birth

string | null · date-time

The date of birth of the user.

profile_city

string | null

The city of the user.

profile_zip

string | null

The postal code or zip code of the user.

profile_state

string | null

The province or state of the user.

profile_address

string | null

The street address of the user.

profile_address_line_2

string | null

The second line of the address of the user.

profile_country

string | null

The ISO 3166-1 alpha-2 country code of the user.

telephone

string | null

A phone number for the user.

object

Update a user › Responses

User

User

id

integer · required

tenant_id

integer | null · required

name

string · required

first_name

string | null · required

last_name

string | null · required

middle_name

string | null · required

preferred_name

string | null · required

date_of_birth

string | null · date-time · required

email

string · required

email_locked

boolean · required

requires_password_reset

boolean · required

photo_url

string | null · required

uses_two_factor_auth

boolean · required

current_team_id

integer | null · required

stripe_id

string | null · required

current_billing_plan

string | null · required

billing_state

string | null · required

vat_id

string | null · required

trial_ends_at

string | null · date-time · required

last_read_announcements_at

string | null · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

work_phone

string | null · required

profile_address

string | null · required

profile_address_line_2

string | null · required

profile_city

string | null · required

profile_state

string | null · required

profile_zip

string | null · required

profile_country

string | null · required

family_id

integer | null · required

manager

boolean · required

places_id

string | null · required

status

integer · required

telephone

string | null · required

timezone

string | null · required

deleted_timestamp

string | null · date-time · required

member_id

string | null · required

card_id

string | null · required

business_name

string | null · required

account_id

integer | null · required

can_use_card

boolean · required

is_communal_admin

boolean · required

referrer

string | null · required

anonymized_at

string | null · date-time · required

active

string · required

two_factor_enabled

string · required

base_membership_plan

null · required

membership_start_date

null · required

readable_membership_start_date

null · required

PUT/users/{user}

curl http://api.community-management.test/api/users/:user \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "first_name": "first_name",
  "last_name": "last_name",
  "middle_name": "middle_name",
  "preferred_name": "preferred_name",
  "date_of_birth": "2024-08-25T15:00:00Z",
  "email": "test@example.com",
  "profile_city": "profile_city",
  "profile_zip": "profile_zip",
  "profile_state": "profile_state",
  "profile_address": "profile_address",
  "profile_address_line_2": "profile_address_line_2",
  "profile_country": "profile_country",
  "telephone": "telephone",
  "custom_form": {
    "id": 0,
    "data": [
      "string"
    ]
  }
}'

Example Request Body

{
  "name": "name",
  "first_name": "first_name",
  "last_name": "last_name",
  "middle_name": "middle_name",
  "preferred_name": "preferred_name",
  "date_of_birth": "2024-08-25T15:00:00Z",
  "email": "test@example.com",
  "profile_city": "profile_city",
  "profile_zip": "profile_zip",
  "profile_state": "profile_state",
  "profile_address": "profile_address",
  "profile_address_line_2": "profile_address_line_2",
  "profile_country": "profile_country",
  "telephone": "telephone",
  "custom_form": {
    "id": 0,
    "data": [
      "string"
    ]
  }
}

json

Example Responses

{
  "id": 0,
  "tenant_id": 0,
  "name": "name",
  "first_name": "first_name",
  "last_name": "last_name",
  "middle_name": "middle_name",
  "preferred_name": "preferred_name",
  "date_of_birth": "2024-08-25T15:00:00Z",
  "email": "email",
  "email_locked": true,
  "requires_password_reset": true,
  "photo_url": "photo_url",
  "uses_two_factor_auth": true,
  "current_team_id": 0,
  "stripe_id": "stripe_id",
  "current_billing_plan": "current_billing_plan",
  "billing_state": "billing_state",
  "vat_id": "vat_id",
  "trial_ends_at": "2024-08-25T15:00:00Z",
  "last_read_announcements_at": "last_read_announcements_at",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "work_phone": "work_phone",
  "profile_address": "profile_address",
  "profile_address_line_2": "profile_address_line_2",
  "profile_city": "profile_city",
  "profile_state": "profile_state",
  "profile_zip": "profile_zip",
  "profile_country": "profile_country",
  "family_id": 0,
  "manager": true,
  "places_id": "places_id",
  "status": 0,
  "telephone": "telephone",
  "timezone": "timezone",
  "deleted_timestamp": "2024-08-25T15:00:00Z",
  "member_id": "member_id",
  "card_id": "card_id",
  "business_name": "business_name",
  "account_id": 0,
  "can_use_card": true,
  "is_communal_admin": true,
  "referrer": "referrer",
  "anonymized_at": "2024-08-25T15:00:00Z",
  "active": "active",
  "two_factor_enabled": "two_factor_enabled",
  "base_membership_plan": null,
  "membership_start_date": null,
  "readable_membership_start_date": null
}

json

application/json

Activity Custom Profile Field

Show a user

GET

http://api.community-management.test/api

/users/{user}

Show a user › path Parameters

user

integer · required

Show a user › query Parameters

include

string

Include related data. Options: card, family, roles,permissions, files.

filter[tenant_id]

string

For parent tenants, optionally show users from a child tenant or all visible child tenants.

Show a user › Headers

X-Api-Version

string

Optional 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

UserResource

id

string · required

name

string · required

email

string · required

date_of_birth

string | null · required

telephone

string

first_name

string

middle_name

string

last_name

string

preferred_name

string

created_at

string | null

updated_at

string | null

subscriptions

string

FamilyMember[]

Update a user

PUT

http://api.community-management.test/api

/users/{user}

Performs an user update request.

Update a user › path Parameters

user

string · required

Update a user › Headers

X-Api-Version

string

Optional 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_name

string · maxLength: 255 · required

The first name of the user.

last_name

string · maxLength: 255 · required

The last name of the user.

email

string · email · required

A unique email address for the user.

name

string | null

The full name of the user (generated from first/last name).

middle_name

string | null · maxLength: 255

The middle name of the user.

preferred_name

string | null · maxLength: 255

The preferred name of the user.

date_of_birth

string | null · date-time

The date of birth of the user.

profile_city

string | null

The city of the user.

profile_zip

string | null

The postal code or zip code of the user.

profile_state

string | null

The province or state of the user.

profile_address

string | null

The street address of the user.

profile_address_line_2

string | null

The second line of the address of the user.

profile_country

string | null

The ISO 3166-1 alpha-2 country code of the user.

telephone

string | null

A phone number for the user.

object

Update a user › Responses

User

User

id

integer · required

tenant_id

integer | null · required

name

string · required

first_name

string | null · required

last_name

string | null · required

middle_name

string | null · required

preferred_name

string | null · required

date_of_birth

string | null · date-time · required

email

string · required

email_locked

boolean · required

requires_password_reset

boolean · required

photo_url

string | null · required

uses_two_factor_auth

boolean · required

current_team_id

integer | null · required

stripe_id

string | null · required

current_billing_plan

string | null · required

billing_state

string | null · required

vat_id

string | null · required

trial_ends_at

string | null · date-time · required

last_read_announcements_at

string | null · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

work_phone

string | null · required

profile_address

string | null · required

profile_address_line_2

string | null · required

profile_city

string | null · required

profile_state

string | null · required

profile_zip

string | null · required

profile_country

string | null · required

family_id

integer | null · required

manager

boolean · required

places_id

string | null · required

status

integer · required

telephone

string | null · required

timezone

string | null · required

deleted_timestamp

string | null · date-time · required

member_id

string | null · required

card_id

string | null · required

business_name

string | null · required

account_id

integer | null · required

can_use_card

boolean · required

is_communal_admin

boolean · required

referrer

string | null · required

anonymized_at

string | null · date-time · required

active

string · required

two_factor_enabled

string · required

base_membership_plan

null · required

membership_start_date

null · required

readable_membership_start_date

null · required