WelcomeHome API V1 (v1)

Download OpenAPI specification: Download

Authorization Request Header

When making requests, include your API Token in an Authorization request header like so:

Authorization: Token token={your_token_here}

You can test your API token using the "/api/ping" endpoint. For example:

curl https://crm.welcomehomesoftware.com/api/ping -H "Authorization: Token token={token_here}"

A successful authentication returns with response code 200 and a JSON body describing the account the token provides access to. E.g.,

{"account_id":2,"lead_source_id":null}

A failed authentication returns with response code 401 and the message:

{"error":"Bad credentials"}

A failed authorization returns with response code 403 and the message:

{"error":"Not authorized to perform this action"}

Authentication

api_key

Authorization Request Header

When making requests, include your API Token in an Authorization request header like so:

Authorization: Token token={your_token_here}

You can test your API token using the "/api/ping" endpoint. For example:

curl https://crm.welcomehomesoftware.com/api/ping -H "Authorization: Token token={token_here}"

A successful authentication returns with response code 200 and a JSON body describing the account the token provides access to. E.g.,

{"account_id":2,"lead_source_id":null}

A failed authentication returns with response code 401 and the message:

{"error":"Bad credentials"}

A failed authorization returns with response code 403 and the message:

{"error":"Not authorized to perform this action"}

| Security scheme type: | HTTP | | HTTP Authorization Scheme | bearer |

Activities

List Activities

query Parameters

Responses

200 list activities (expand to read about pagination)

get/activities

Production Server

https://crm.welcomehomesoftware.com/api/activities

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"completed_at": "2026-10-12T13:22:23Z",
    \
  • ​"direction": "string",
    \
  • ​"notes": "string",
    \
  • ​"sales_counselor_id": 0,
    \
  • ​"scheduled_at": "2026-10-12T13:22:23Z",
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z",
    \
  • ​"record_type": "string",
    \
  • ​"record_id": 0,
    \
  • ​"stage_id": 0,
    \
  • ​"activity_type_id": 0,
    \
  • ​"discarded_at": "2026-10-12T13:22:23Z",
    \
  • ​"activity_result_id": 0,
    \
  • ​"pinned": true,
    \
  • ​"community_id": 0,
    \
  • ​"created_by_id": 0,
    \
  • ​"completed_successfully": true,
    \
  • ​"add_to_calendar": true,
    \
  • ​"time_zone": "Eastern Time (US & Canada)",
    \
  • ​"calendar_event_start_time": "14:00",
    \
  • ​"calendar_event_end_time": "15:00",
    \
  • ​"person_ids":
    
    
    
    [
    \
    • ​0
      
      
      ]
      
      }
      
      ]

List Prospect Activities

Responses

200 list activities

get/prospects/{prospect_id}/activities

Production Server

https://crm.welcomehomesoftware.com/api/prospects/{prospect\_id}/activities

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"completed_at": "2026-10-12T13:22:23Z",
    \
  • ​"direction": "string",
    \
  • ​"notes": "string",
    \
  • ​"sales_counselor_id": 0,
    \
  • ​"scheduled_at": "2026-10-12T13:22:23Z",
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z",
    \
  • ​"record_type": "string",
    \
  • ​"record_id": 0,
    \
  • ​"stage_id": 0,
    \
  • ​"activity_type_id": 0,
    \
  • ​"discarded_at": "2026-10-12T13:22:23Z",
    \
  • ​"activity_result_id": 0,
    \
  • ​"pinned": true,
    \
  • ​"community_id": 0,
    \
  • ​"created_by_id": 0,
    \
  • ​"completed_successfully": true,
    \
  • ​"add_to_calendar": true,
    \
  • ​"time_zone": "Eastern Time (US & Canada)",
    \
  • ​"calendar_event_start_time": "14:00",
    \
  • ​"calendar_event_end_time": "15:00",
    \
  • ​"person_ids":
    
    
    
    [
    \
    • ​0
      
      
      ]
      
      }
      
      ]

Create Activity

To add a start and end time, "add_to_calendar": true must be passed along with time_zone, calendar_event_start_time, and calendar_event_end_time. calendar_event_start_time and calendar_event_end_time also support Meridian indicators like "3:00 PM". The standard North American time zones are: ["Eastern Time (US & Canada)", "Central Time (US & Canada)", "Mountain Time (US & Canada)", "Pacific Time (US & Canada)", "Alaska", "Arizona", "Hawaii"]

Request Body schema: application/json

Responses

200 Create an activity

post/prospects/{prospect_id}/activities

Production Server

https://crm.welcomehomesoftware.com/api/prospects/{prospect\_id}/activities

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"activity":

{

• ​

  "activity_result_id": 0,

• ​

  "activity_type_id": 0,

• ​

  "completed_at": "2026-10-12T13:22:23Z",

• ​

  "direction": "string",

• ​

  "notes": "string",

• ​

  "pinned": true,

• ​

  "sales_counselor_id": 0,

• ​

  "scheduled_at": "2026-10-12T13:22:23Z",

• ​

  "add_to_calendar": true,

• ​

  "time_zone": "Eastern Time (US & Canada)",

• ​

  "calendar_event_start_time": "14:00",

• ​

  "calendar_event_end_time": "15:00",

• ​

  "person_ids":

  [
  \

  • ​0
    
    
    ]

}

}

Response samples

• ​200

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "completed_at": "2026-10-12T13:22:23Z",

• ​

  "direction": "string",

• ​

  "notes": "string",

• ​

  "sales_counselor_id": 0,

• ​

  "scheduled_at": "2026-10-12T13:22:23Z",

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z",

• ​

  "record_type": "string",

• ​

  "record_id": 0,

• ​

  "stage_id": 0,

• ​

  "activity_type_id": 0,

• ​

  "discarded_at": "2026-10-12T13:22:23Z",

• ​

  "activity_result_id": 0,

• ​

  "pinned": true,

• ​

  "community_id": 0,

• ​

  "created_by_id": 0,

• ​

  "completed_successfully": true,

• ​

  "time_zone": "Eastern Time (US & Canada)",

• ​

  "calendar_event_start_time": "14:00",

• ​

  "calendar_event_end_time": "15:00",

• ​

  "person_ids":

[
\

• ​0
  
  
  ]

}

Update Prospect Activity

To add a start and end time, "add_to_calendar": true must be passed along with time_zone, calendar_event_start_time, and calendar_event_end_time. calendar_event_start_time and calendar_event_end_time also support Meridian indicators like "3:00 PM". The standard North American time zones are: ["Eastern Time (US & Canada)", "Central Time (US & Canada)", "Mountain Time (US & Canada)", "Pacific Time (US & Canada)", "Alaska", "Arizona", "Hawaii"]

Request Body schema: application/json

Responses

200 success

put/prospects/{prospect_id}/activities/{activity_id}

Production Server

https://crm.welcomehomesoftware.com/api/prospects/{prospect\_id}/activities/{activity\_id}

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"activity":

{

• ​

  "activity_result_id": 0,

• ​

  "activity_type_id": 0,

• ​

  "completed_at": "2026-10-12T13:22:23Z",

• ​

  "direction": "string",

• ​

  "notes": "string",

• ​

  "pinned": true,

• ​

  "sales_counselor_id": 0,

• ​

  "scheduled_at": "2026-10-12T13:22:23Z",

• ​

  "add_to_calendar": true,

• ​

  "time_zone": "Eastern Time (US & Canada)",

• ​

  "calendar_event_start_time": "14:00",

• ​

  "calendar_event_end_time": "15:00",

• ​

  "person_ids":

  [
  \

  • ​0
    
    
    ]

}

}

Response samples

• ​200

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "completed_at": "2026-10-12T13:22:23Z",

• ​

  "direction": "string",

• ​

  "notes": "string",

• ​

  "sales_counselor_id": 0,

• ​

  "scheduled_at": "2026-10-12T13:22:23Z",

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z",

• ​

  "record_type": "string",

• ​

  "record_id": 0,

• ​

  "stage_id": 0,

• ​

  "activity_type_id": 0,

• ​

  "discarded_at": "2026-10-12T13:22:23Z",

• ​

  "activity_result_id": 0,

• ​

  "pinned": true,

• ​

  "community_id": 0,

• ​

  "created_by_id": 0,

• ​

  "completed_successfully": true,

• ​

  "add_to_calendar": true,

• ​

  "time_zone": "Eastern Time (US & Canada)",

• ​

  "calendar_event_start_time": "14:00",

• ​

  "calendar_event_end_time": "15:00",

• ​

  "person_ids":

[
\

• ​0
  
  
  ]

}

List Activity Results

Responses

200 list activity results

get/activity_results

Production Server

https://crm.welcomehomesoftware.com/api/activity\_results

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"name": "string",
    \
  • ​"successful": true,
    \
  • ​"discarded_at": "2026-10-12T13:22:23Z",
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

List Activity Types

Responses

200 list activity types

get/activity_types

Production Server

https://crm.welcomehomesoftware.com/api/activity\_types

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"account_id": 0,
    \
  • ​"name": "Tour",
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Care Types

List Care Types

Responses

200 list care types

get/care_types

Production Server

https://crm.welcomehomesoftware.com/api/care\_types

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"name": "Assisted Living",
    \
  • ​"abbreviation": "AL",
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Close Reasons

List Close Reasons

Responses

200 list close reasons

get/close_reasons

Production Server

https://crm.welcomehomesoftware.com/api/close\_reasons

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"name": "string",
    \
  • ​"details_type": "none",
    \
  • ​"details_description": "string",
    \
  • ​"deceased_close_reason": true,
    \
  • ​"discarded_at": "2026-10-12T13:22:23Z",
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Communities

List Communities

Responses

200 list communities

get/communities

Production Server

https://crm.welcomehomesoftware.com/api/communities

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"name": "Community Name",
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Events

List Events

query Parameters

Responses

200 ok

get/events

Production Server

https://crm.welcomehomesoftware.com/api/events

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"community_id": 0,
    \
  • ​"name": "string",
    \
  • ​"host_id": 0,
    \
  • ​"date": "1/31/2000",
    \
  • ​"start_time": "14:00",
    \
  • ​"end_time": "15:00",
    \
  • ​"time_zone": "Eastern Time (US & Canada)",
    \
  • ​"location": "Morningside of Bellaire",
    \
  • ​"address": "123 Main St, NY, NY",
    \
  • ​"budget": 2200.5,
    \
  • ​"total_cost": 2100,
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Create Event

Request Body schema: application/json

Responses

201 created

post/events

Production Server

https://crm.welcomehomesoftware.com/api/events

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"event":

{

• ​

  "community_id": 0,

• ​

  "name": "string",

• ​

  "host_id": 0,

• ​

  "date": "1/31/2000",

• ​

  "start_time": "14:00",

• ​

  "end_time": "15:00",

• ​

  "time_zone": "Eastern Time (US & Canada)",

• ​

  "location": "Morningside of Bellaire",

• ​

  "address": "123 Main St, NY, NY",

• ​

  "budget": 2200.5,

• ​

  "total_cost": 2100

}

}

Response samples

• ​201

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "community_id": 0,

• ​

  "name": "string",

• ​

  "host_id": 0,

• ​

  "date": "1/31/2000",

• ​

  "start_time": "14:00",

• ​

  "end_time": "15:00",

• ​

  "time_zone": "Eastern Time (US & Canada)",

• ​

  "location": "Morningside of Bellaire",

• ​

  "address": "123 Main St, NY, NY",

• ​

  "budget": 2200.5,

• ​

  "total_cost": 2100,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

RSVP to an Event

This endpoint updates an RSVP status of an invite that corresponds to a person's email or ID, for the given event.

Either an email or a person ID is required.

If both an email and a person ID are present, only the person ID will be used. If the email is used for multiple people who are invited to the event, all of the corresponding invites will be updated to the given status.

If an email or a person ID for an uninvited person is submitted, then that person's Prospect or Referrer record will be invited to the event, and the invite that corresponds to the submitted email or ID will be updated to the given status.

All people with an invite to the corresponding event that match the provided email address will be updated to the same status.

If an email or person ID is submitted that does not exist, this endpoint returns a 404 response.

If no status parameter or neither email or person ID parameters are submitted, this endpoint returns a 422 response.

path Parameters

Request Body schema: application/json

Responses

200 success

404 not_found

422 unprocessable_entity

post/events/{event_id}/rsvps

Production Server

https://crm.welcomehomesoftware.com/api/events/{event\_id}/rsvps

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​

  "email": "string",

• ​

  "status": "pending_response",

• ​

  "person_id": 0

}

Exports

Live, paginated CSV data

This endpoint provides live, paginated bulk export capability.

This endpoint is the most efficient way to get a full data dump out of WelcomeHome. It can also be used to poll for changes by filtering based on updated_at.

For example, a common strategy used to maintain an up-to-date copy of WelcomeHome's data is to:

• ​

  Perform an initial pull of each table, paging through all results to get an entire copy of the dataset

• ​

  Periodically re-poll, but using updated_at_after to retrieve any changes made since the last poll.

By default, this endpoint returns 1000 results per page. To retrieve all data, be sure to request each page until all pages have been fetched.

If the response has been paginated and there are more records to retrieve, the "Link" header will be present with a URL that can be used to fetch the next page.

E.g., Link: <https://crm.welcomehomesoftware.com/api/path/to/endpoint?cursor=6eb0d8c2e74cedf3>; rel="next"

Note: a given cursor can only be used 3 times within a single minute, a limit imposed to mitigate infinitely pulling the same page.

All timestamps are in UTC unless otherwise specified.

path Parameters

query Parameters

Responses

200 CSV (expand to read about pagination)

get/exports/community/{community_id}/table/{table}

Production Server

https://crm.welcomehomesoftware.com/api/exports/community/{community\_id}/table/{table}

Daily snapshot of CSV data

This endpoint provides access to unpaginated, daily snapshots of the same content that can be retrieved from the live, paginated export endpoint.

The snapshots are generated nightly. In order to use this endpoint, please contact [email protected] to ask for the daily snapshot export endpoint to be activated.

This endpoint may be a better choice for Business Intelligence (BI) integrations in which:

• ​Daily frequency is sufficient
• ​Pagination is difficult or cumbersome

Requires an API Token with access to all communities

All timestamps are in UTC unless otherwise specified.

path Parameters

query Parameters

Responses

200 CSV content (when direct=true)

301 Redirect to CSV location (default)

get/exports/daily_snapshots/table/{table}

Production Server

https://crm.welcomehomesoftware.com/api/exports/daily\_snapshots/table/{table}

Floor Plans

List Floor Plans

query Parameters

Responses

200 list floor plans

get/floor_plans

Production Server

https://crm.welcomehomesoftware.com/api/floor\_plans

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"community_id": 0,
    \
  • ​"name": "string",
    \
  • ​"square_feet": 0,
    \
  • ​"beds": 0,
    \
  • ​"baths": null,
    \
  • ​"occupancy_points": null,
    \
  • ​"default_privacy_level_id": 0,
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

HousingContracts

List Housing Contracts

query Parameters

Responses

200 list housing contracts

get/housing_contracts

Production Server

https://crm.welcomehomesoftware.com/api/housing\_contracts

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"community_id": 0,
    \
  • ​"unit_id": 0,
    \
  • ​"move_in_date": null,
    \
  • ​"move_out_date": null,
    \
  • ​"financial_move_in_date": null,
    \
  • ​"financial_move_out_date": null,
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z",
    \
  • ​"move_out_reason_id": 0,
    \
  • ​"monthly_rate": 0,
    \
  • ​"recurring_concession": 0,
    \
  • ​"one_time_concession": 0,
    \
  • ​"sales_counselor_id": 0,
    \
  • ​"notice_given_date": null,
    \
  • ​"deposit_received_on": null,
    \
  • ​"deposit_amount": 0,
    \
  • ​"occupancy_point_factor": 0,
    \
  • ​"community_fee_amount": 0,
    \
  • ​"community_fee_received_on": null,
    \
  • ​"risk_level": 0,
    \
  • ​"transfer_from_id": 0,
    \
  • ​"count_move_in": true,
    \
  • ​"count_move_out": true,
    \
  • ​"stay_type": "permanent",
    \
  • ​"concession_description": "string",
    \
  • ​"privacy_level_id": 0,
    \
  • ​"privacy_level_variant": "A",
    \
  • ​"move_out_reason_details": "string",
    \
  • ​"resident_count_override": 0,
    \
  • ​"leased_on": null,
    \
  • ​"lease_canceled_on": null,
    \
  • ​"prospect_ids":
    
    
    
    [
    \
    • ​0
      
      
      ],
      \
  • ​"resident_ids":
    
    
    
    [
    \
    • ​0
      
      
      ],
      \
  • ​"status": "future",
    \
  • ​"housing_contract_field_values_attributes":
    
    
    
    [
    \
    • ​{
      \
      • ​"id": 0,
        \
      • ​"housing_contract_field_id": 0,
        \
      • ​"housing_contract_field_name": "string",
        \
      • ​"value": "string"
        
        
        }
        
        ]
        
        }
        
        ]

Create Housing Contract

Request Body schema: application/json

Responses

201 created

422 unprocessable_entity

post/housing_contracts

Production Server

https://crm.welcomehomesoftware.com/api/housing\_contracts

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"housing_contract":

{

• ​

  "community_id": 0,

• ​

  "unit_id": 0,

• ​

  "resident_ids":

  [
  \

  • ​0
    
    
    ],
• ​

  "move_in_date": null,

• ​

  "financial_move_in_date": null,

• ​

  "move_out_date": null,

• ​

  "financial_move_out_date": null,

• ​

  "notice_given_date": null,

• ​

  "leased_on": null,

• ​

  "lease_canceled_on": null,

• ​

  "move_out_reason_id": 0,

• ​

  "move_out_reason_details": "string",

• ​

  "privacy_level_id": 0,

• ​

  "privacy_level_variant": "A",

• ​

  "sales_counselor_id": 0,

• ​

  "stay_type": "permanent",

• ​

  "monthly_rate": 0,

• ​

  "one_time_concession": 0,

• ​

  "recurring_concession": 0,

• ​

  "concession_description": "string",

• ​

  "resident_count_override": 0,

• ​

  "count_move_in": true,

• ​

  "count_move_out": true

}

}

Response samples

• ​201
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "community_id": 0,

• ​

  "unit_id": 0,

• ​

  "move_in_date": null,

• ​

  "move_out_date": null,

• ​

  "financial_move_in_date": null,

• ​

  "financial_move_out_date": null,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z",

• ​

  "move_out_reason_id": 0,

• ​

  "monthly_rate": 0,

• ​

  "recurring_concession": 0,

• ​

  "one_time_concession": 0,

• ​

  "sales_counselor_id": 0,

• ​

  "notice_given_date": null,

• ​

  "deposit_received_on": null,

• ​

  "deposit_amount": 0,

• ​

  "occupancy_point_factor": 0,

• ​

  "community_fee_amount": 0,

• ​

  "community_fee_received_on": null,

• ​

  "risk_level": 0,

• ​

  "transfer_from_id": 0,

• ​

  "count_move_in": true,

• ​

  "count_move_out": true,

• ​

  "stay_type": "permanent",

• ​

  "concession_description": "string",

• ​

  "privacy_level_id": 0,

• ​

  "privacy_level_variant": "A",

• ​

  "move_out_reason_details": "string",

• ​

  "resident_count_override": 0,

• ​

  "leased_on": null,

• ​

  "lease_canceled_on": null,

• ​

  "prospect_ids":

[
\

• ​

  0
  
  
  ],

• ​

  "resident_ids":

[
\

• ​

  0
  
  
  ],

• ​

  "status": "future",

• ​

  "housing_contract_field_values_attributes":

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"housing_contract_field_id": 0,
    \
  • ​"housing_contract_field_name": "string",
    \
  • ​"value": "string"
    
    
    }
    
    ]

}

Update Housing Contract

path Parameters

Request Body schema: application/json

Responses

200 ok

422 unprocessable_entity

put/housing_contracts/{id}

Production Server

https://crm.welcomehomesoftware.com/api/housing\_contracts/{id}

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"housing_contract":

{

• ​

  "unit_id": 0,

• ​

  "resident_ids":

  [
  \

  • ​0
    
    
    ],
• ​

  "move_in_date": null,

• ​

  "financial_move_in_date": null,

• ​

  "move_out_date": null,

• ​

  "financial_move_out_date": null,

• ​

  "notice_given_date": null,

• ​

  "leased_on": null,

• ​

  "lease_canceled_on": null,

• ​

  "move_out_reason_id": 0,

• ​

  "move_out_reason_details": "string",

• ​

  "privacy_level_id": 0,

• ​

  "privacy_level_variant": "A",

• ​

  "sales_counselor_id": 0,

• ​

  "stay_type": "permanent",

• ​

  "monthly_rate": 0,

• ​

  "one_time_concession": 0,

• ​

  "recurring_concession": 0,

• ​

  "concession_description": "string",

• ​

  "resident_count_override": 0,

• ​

  "count_move_in": true,

• ​

  "count_move_out": true

}

}

Response samples

• ​200
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "community_id": 0,

• ​

  "unit_id": 0,

• ​

  "move_in_date": null,

• ​

  "move_out_date": null,

• ​

  "financial_move_in_date": null,

• ​

  "financial_move_out_date": null,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z",

• ​

  "move_out_reason_id": 0,

• ​

  "monthly_rate": 0,

• ​

  "recurring_concession": 0,

• ​

  "one_time_concession": 0,

• ​

  "sales_counselor_id": 0,

• ​

  "notice_given_date": null,

• ​

  "deposit_received_on": null,

• ​

  "deposit_amount": 0,

• ​

  "occupancy_point_factor": 0,

• ​

  "community_fee_amount": 0,

• ​

  "community_fee_received_on": null,

• ​

  "risk_level": 0,

• ​

  "transfer_from_id": 0,

• ​

  "count_move_in": true,

• ​

  "count_move_out": true,

• ​

  "stay_type": "permanent",

• ​

  "concession_description": "string",

• ​

  "privacy_level_id": 0,

• ​

  "privacy_level_variant": "A",

• ​

  "move_out_reason_details": "string",

• ​

  "resident_count_override": 0,

• ​

  "leased_on": null,

• ​

  "lease_canceled_on": null,

• ​

  "prospect_ids":

[
\

• ​

  0
  
  
  ],

• ​

  "resident_ids":

[
\

• ​

  0
  
  
  ],

• ​

  "status": "future",

• ​

  "housing_contract_field_values_attributes":

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"housing_contract_field_id": 0,
    \
  • ​"housing_contract_field_name": "string",
    \
  • ​"value": "string"
    
    
    }
    
    ]

}

Influencers

Show Influencer

path Parameters

Responses

200 success

get/influencers/{id}

Production Server

https://crm.welcomehomesoftware.com/api/influencers/{id}

Response samples

• ​200

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "decision_maker": true,

• ​

  "health_care_proxy": true,

• ​

  "person_attributes":

{

• ​

  "id": 0,

• ​

  "first_name": "string",

• ​

  "middle_name": "string",

• ​

  "last_name": "string",

• ​

  "cell_phone": "string",

• ​

  "home_phone": "string",

• ​

  "work_phone": "string",

• ​

  "email": "string",

• ​

  "fax_number": "string",

• ​

  "do_not_call": false,

• ​

  "do_not_email": false,

• ​

  "do_not_mail": false,

• ​

  "do_not_text": false,

• ​

  "birthdate": "string",

• ​

  "provided_age": 0,

• ​

  "gender": "male",

• ​

  "address_attributes":

  {

  • ​

    "line1": "string",

  • ​

    "line2": "string",

  • ​

    "city": "string",

  • ​

    "state": "string",

  • ​

    "zip": "string"

}

},

• ​

  "point_of_contact": true,

• ​

  "power_of_attorney": true,

• ​

  "notes": "string",

• ​

  "relationship_id": 0

}

Update Influencer

The influencers endpoint allows you to update certain data points for influencers in WelcomeHome.

The permitted data points relate to birthdate, age, gender, and address.

Request Body schema: application/json

Responses

200 success

422 unprocessable_entity

put/influencers/{id}

Production Server

https://crm.welcomehomesoftware.com/api/influencers/{id}

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"influencer":

{

• ​

  "notes": "string",

• ​

  "person_attributes":

  {

  • ​

    "first_name": "string",

  • ​

    "middle_name": "string",

  • ​

    "last_name": "string",

  • ​

    "cell_phone": "string",

  • ​

    "home_phone": "string",

  • ​

    "work_phone": "string",

  • ​

    "email": "string",

  • ​

    "fax_number": "string",

  • ​

    "do_not_call": false,

  • ​

    "do_not_email": false,

  • ​

    "do_not_mail": false,

  • ​

    "do_not_text": false,

  • ​

    "birthdate": "string",

  • ​

    "provided_age": 0,

  • ​

    "gender": "male",

  • ​

    "address_attributes":

    {

    • ​

      "line1": "string",

    • ​

      "line2": "string",

    • ​

      "city": "string",

    • ​

      "state": "string",

    • ​

      "zip": "string"

}

},

• ​"relationship_id": 0

}

}

Response samples

• ​200
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "decision_maker": true,

• ​

  "health_care_proxy": true,

• ​

  "person_attributes":

{

• ​

  "id": 0,

• ​

  "first_name": "string",

• ​

  "middle_name": "string",

• ​

  "last_name": "string",

• ​

  "cell_phone": "string",

• ​

  "home_phone": "string",

• ​

  "work_phone": "string",

• ​

  "email": "string",

• ​

  "fax_number": "string",

• ​

  "do_not_call": false,

• ​

  "do_not_email": false,

• ​

  "do_not_mail": false,

• ​

  "do_not_text": false,

• ​

  "birthdate": "string",

• ​

  "provided_age": 0,

• ​

  "gender": "male",

• ​

  "address_attributes":

  {

  • ​

    "line1": "string",

  • ​

    "line2": "string",

  • ​

    "city": "string",

  • ​

    "state": "string",

  • ​

    "zip": "string"

}

},

• ​

  "point_of_contact": true,

• ​

  "power_of_attorney": true,

• ​

  "notes": "string",

• ​

  "relationship_id": 0

}

Lead Sources

List Lead Sources

Responses

200 list lead sources

get/lead_sources

Production Server

https://crm.welcomehomesoftware.com/api/lead\_sources

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"name": "string",
    \
  • ​"category": "string",
    \
  • ​"discarded_at": "2026-10-12T13:22:23Z",
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Move Out Reasons

List Move Out Reasons

Responses

200 list move out reasons

get/move_out_reasons

Production Server

https://crm.welcomehomesoftware.com/api/move\_out\_reasons

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"name": "string",
    \
  • ​"system_reason": "deceased",
    \
  • ​"details_description": "string",
    \
  • ​"discarded_at": "2026-10-12T13:22:23Z",
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Privacy Levels

List Privacy Levels

query Parameters

Responses

200 list privacy levels

get/privacy_levels

Production Server

https://crm.welcomehomesoftware.com/api/privacy\_levels

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"name": "string",
    \
  • ​"community_id": 0,
    \
  • ​"exclude_second_residents_from_resident_count": true,
    \
  • ​"occupants": 0,
    \
  • ​"second_resident_variant": true,
    \
  • ​"second_resident_variant_show_a": true,
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Create Privacy Level

Request Body schema: application/json

Responses

201 created

404 not_found

422 unprocessable_entity

post/privacy_levels

Production Server

https://crm.welcomehomesoftware.com/api/privacy\_levels

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"privacy_level":

{

• ​

  "community_id": 0,

• ​

  "exclude_second_residents_from_resident_count": true,

• ​

  "name": "string",

• ​

  "occupants": 0,

• ​

  "second_resident_variant": true,

• ​

  "second_resident_variant_show_a": true

}

}

Response samples

• ​201
• ​404
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "name": "string",

• ​

  "community_id": 0,

• ​

  "exclude_second_residents_from_resident_count": true,

• ​

  "occupants": 0,

• ​

  "second_resident_variant": true,

• ​

  "second_resident_variant_show_a": true,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Update Privacy Level

path Parameters

Request Body schema: application/json

Responses

200 ok

404 not_found

422 unprocessable_entity

put/privacy_levels/{id}

Production Server

https://crm.welcomehomesoftware.com/api/privacy\_levels/{id}

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"privacy_level":

{

• ​

  "exclude_second_residents_from_resident_count": true,

• ​

  "name": "string",

• ​

  "occupants": 0,

• ​

  "second_resident_variant": true,

• ​

  "second_resident_variant_show_a": true

}

}

Response samples

• ​200
• ​404
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "name": "string",

• ​

  "community_id": 0,

• ​

  "exclude_second_residents_from_resident_count": true,

• ​

  "occupants": 0,

• ​

  "second_resident_variant": true,

• ​

  "second_resident_variant_show_a": true,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Delete Privacy Level

path Parameters

Responses

204 no_content

404 not_found

422 unprocessable_entity

delete/privacy_levels/{id}

Production Server

https://crm.welcomehomesoftware.com/api/privacy\_levels/{id}

Response samples

• ​404
• ​422

application/json

Copy Expand all Collapse all

{

• ​"error": "string"

}

Prospect Fields

List Prospect Fields

Responses

200 list prospect fields

get/prospect_fields

Production Server

https://crm.welcomehomesoftware.com/api/prospect\_fields

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"name": "string",
    \
  • ​"field_type": "amount",
    \
  • ​"position": 0,
    \
  • ​"required": true,
    \
  • ​"show_on_prospect_profile": true,
    \
  • ​"list_options":
    
    
    
    [
    \
    • ​"string"
      
      
      ],
      \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Update Prospect Field

Updates a Prospect Field's name, position, required setting, and profile visibility. For list fields, list_options replaces the complete configured option list in the submitted order. Omit list_options to leave the configured options unchanged.

path Parameters

Request Body schema: application/json

Responses

200 update prospect field

422 list options are not applicable

put/prospect_fields/{id}

Production Server

https://crm.welcomehomesoftware.com/api/prospect\_fields/{id}

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"prospect_field":

{

• ​

  "name": "string",

• ​

  "position": 0,

• ​

  "required": true,

• ​

  "show_on_prospect_profile": true,

• ​

  "list_options":

  [
  \

  • ​"string"
    
    
    ]

}

}

Response samples

• ​200
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "name": "string",

• ​

  "field_type": "amount",

• ​

  "position": 0,

• ​

  "required": true,

• ​

  "show_on_prospect_profile": true,

• ​

  "list_options":

[
\

• ​

  "string"
  
  
  ],

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Prospects

Create Prospect

The prospects endpoint allows you to add new prospects into WelcomeHome.

When you add a new prospect, it appear on top of a new prospects dashboard. We also send notifications to users via email / mobile push as per their preferences.

A prospect record must have at least one influencer or resident. And at least one of those records must have a first or last name. All other field are optional and should be omitted if intended to be left blank.

Request Body schema: application/json

Responses

201 Create a prospect

post/prospects

Production Server

https://crm.welcomehomesoftware.com/api/prospects

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"prospect":

{

• ​

  "community_id": 0,

• ​

  "marketing_touchpoints_attributes":

  [
  \

  • ​{
    \
    • ​"lead_source_id": 0,
      \
    • ​"campaign_name": "string",
      \
    • ​"occurred_at": "2026-10-12T13:22:23Z"
      
      
      }
      
      ],
• ​

  "residents_attributes":

  [
  \

  • ​{
    \
    • ​"care_type_id": 0,
      \
    • ​"person_attributes":
      
      
      
      {
      \
      • ​"first_name": "string",
        \
      • ​"middle_name": "string",
        \
      • ​"last_name": "string",
        \
      • ​"cell_phone": "string",
        \
      • ​"home_phone": "string",
        \
      • ​"work_phone": "string",
        \
      • ​"email": "string",
        \
      • ​"fax_number": "string",
        \
      • ​"do_not_call": false,
        \
      • ​"do_not_email": false,
        \
      • ​"do_not_mail": false,
        \
      • ​"do_not_text": false,
        \
      • ​"birthdate": "string",
        \
      • ​"provided_age": 0,
        \
      • ​"gender": "male",
        \
      • ​"address_attributes":
        
        
        
        {
        \
        • ​"line1": "string",
          \
        • ​"line2": "string",
          \
        • ​"city": "string",
          \
        • ​"state": "string",
          \
        • ​"zip": "string"
          
          
          }
          
          }
          
          }
          
          ],
• ​

  "influencers_attributes":

  [
  \

  • ​{
    \
    • ​"notes": "string",
      \
    • ​"person_attributes":
      
      
      
      {
      \
      • ​"first_name": "string",
        \
      • ​"middle_name": "string",
        \
      • ​"last_name": "string",
        \
      • ​"cell_phone": "string",
        \
      • ​"home_phone": "string",
        \
      • ​"work_phone": "string",
        \
      • ​"email": "string",
        \
      • ​"fax_number": "string",
        \
      • ​"do_not_call": false,
        \
      • ​"do_not_email": false,
        \
      • ​"do_not_mail": false,
        \
      • ​"do_not_text": false,
        \
      • ​"birthdate": "string",
        \
      • ​"provided_age": 0,
        \
      • ​"gender": "male",
        \
      • ​"address_attributes":
        
        
        
        {
        \
        • ​"line1": "string",
          \
        • ​"line2": "string",
          \
        • ​"city": "string",
          \
        • ​"state": "string",
          \
        • ​"zip": "string"
          
          
          }
          
          },
          \
    • ​"relationship_id": 0
      
      
      }
      
      ],
• ​

  "expected_move_timing_id": 0,

• ​

  "lead_source_id": 0,

• ​

  "secondary_lead_source_id": 0,

• ​

  "metadata":

  {

  • ​

    "utm_campaign": "campaign-1",

  • ​

    "utm_term": "senior living"

},

• ​

  "notes": "string",

• ​

  "prospect_field_values_attributes":

  [
  \

  • ​{
    \
    • ​"prospect_field_id": 0,
      \
    • ​"value": "string"
      
      
      }
      
      ],
• ​

  "referrer_id": 0,

• ​

  "score_id": 0,

• ​

  "status": "open",

• ​

  "trait_ids":

  [
  \

  • ​0
    
    
    ]

}

}

Response samples

• ​201

application/json

Copy Expand all Collapse all

{

• ​

  "account_id": 0,

• ​

  "active_at": "2026-10-12T13:22:23Z",

• ​

  "close_reason_details": "string",

• ​

  "close_reason_id": 0,

• ​

  "community_id": 0,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "discarded_at": "2026-10-12T13:22:23Z",

• ​

  "discarded_by_id": 0,

• ​

  "expected_move_timing_id": 0,

• ​

  "id": 0,

• ​

  "initial_contact_at": "2026-10-12T13:22:23Z",

• ​

  "last_contact_at": "2026-10-12T13:22:23Z",

• ​

  "lead_source_id": 0,

• ​

  "metadata":

{

• ​

  "utm_campaign": "campaign-1",

• ​

  "utm_term": "senior living"

},

• ​

  "merged_into_prospect_id": 0,

• ​

  "next_activity_scheduled_at": "2026-10-12T13:22:23Z",

• ​

  "original_sales_counselor_id": 0,

• ​

  "referrer_id": 0,

• ​

  "sales_counselor_id": 0,

• ​

  "score_id": 0,

• ​

  "secondary_lead_source_id": 0,

• ​

  "stage_id": 0,

• ​

  "status": "open",

• ​

  "status_changed_at": "2026-10-12T13:22:23Z",

• ​

  "trait_ids": [ ],

• ​

  "updated_at": "2026-10-12T13:22:23Z",

• ​

  "residents_attributes":

[
\

• ​

  {
  \

  • ​"id": 0,
    \
  • ​"person_attributes":
    
    
    
    {
    \
    • ​"id": 0,
      \
    • ​"first_name": "string",
      \
    • ​"middle_name": "string",
      \
    • ​"last_name": "string",
      \
    • ​"cell_phone": "string",
      \
    • ​"home_phone": "string",
      \
    • ​"work_phone": "string",
      \
    • ​"email": "string",
      \
    • ​"fax_number": "string",
      \
    • ​"do_not_call": false,
      \
    • ​"do_not_email": false,
      \
    • ​"do_not_mail": false,
      \
    • ​"do_not_text": false,
      \
    • ​"birthdate": "string",
      \
    • ​"provided_age": 0,
      \
    • ​"gender": "male",
      \
    • ​"address_attributes":
      
      
      
      {
      \
      • ​"line1": "string",
        \
      • ​"line2": "string",
        \
      • ​"city": "string",
        \
      • ​"state": "string",
        \
      • ​"zip": "string"
        
        
        }
        
        },
        \
  • ​"care_type_id": 0,
    \
  • ​"marital_status": "single",
    \
  • ​"veteran_status": "unknown"
    
    
    }
    
    ],
• ​

  "influencers_attributes":

[
\

• ​

  {
  \

  • ​"id": 0,
    \
  • ​"person_attributes":
    
    
    
    {
    \
    • ​"id": 0,
      \
    • ​"first_name": "string",
      \
    • ​"middle_name": "string",
      \
    • ​"last_name": "string",
      \
    • ​"cell_phone": "string",
      \
    • ​"home_phone": "string",
      \
    • ​"work_phone": "string",
      \
    • ​"email": "string",
      \
    • ​"fax_number": "string",
      \
    • ​"do_not_call": false,
      \
    • ​"do_not_email": false,
      \
    • ​"do_not_mail": false,
      \
    • ​"do_not_text": false,
      \
    • ​"birthdate": "string",
      \
    • ​"provided_age": 0,
      \
    • ​"gender": "male",
      \
    • ​"address_attributes":
      
      
      
      {
      \
      • ​"line1": "string",
        \
      • ​"line2": "string",
        \
      • ​"city": "string",
        \
      • ​"state": "string",
        \
      • ​"zip": "string"
        
        
        }
        
        },
        \
  • ​"decision_maker": true,
    \
  • ​"health_care_proxy": true,
    \
  • ​"notes": "string",
    \
  • ​"point_of_contact": true,
    \
  • ​"power_of_attorney": true,
    \
  • ​"relationship_id": 0
    
    
    }
    
    ],
• ​

  "prospect_field_values_attributes":

[
\

• ​{
  \
  • ​"prospect_field_id": 0,
    \
  • ​"value": "string"
    
    
    }
    
    ]

}

Create or Update Prospect from a Marketing Form

This endpoint is designed to support the type of form you would expect to see on a Senior Living community website.

The endpoint either creates a new prospect or updates an existing one. An update occurs if there is already a prospect with a matching email or phone number.

When a new prospect is created, it appears on top of a new prospects dashboard. We also send notifications to users via email / mobile push as per their preferences.

See individual field descriptions for more information.

Request Body schema: application/json

Responses

200 Prospect

post/prospects/marketing_form

Production Server

https://crm.welcomehomesoftware.com/api/prospects/marketing\_form

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"marketing_form":

{

• ​

  "community_id": 0,

• ​

  "email": "string",

• ​

  "first_name": "string",

• ​

  "last_name": "string",

• ​

  "lead_source_id": 0,

• ​

  "referrer_id": 0,

• ​

  "notes": "string",

• ​

  "phone_number": "string",

• ​

  "relationship": "string",

• ​

  "do_not_call": null,

• ​

  "do_not_email": null,

• ​

  "do_not_text": null,

• ​

  "do_not_mail": null,

• ​

  "second_person_first_name": "string",

• ​

  "second_person_last_name": "string",

• ​

  "activity":

  {

  • ​

    "activity_type_id": 0,

  • ​

    "completed_at": "2026-10-12T13:22:23Z",

  • ​

    "scheduled_at": "2026-10-12T13:22:23Z",

  • ​

    "pinned": true,

  • ​

    "notes": "string",

  • ​

    "duration_in_minutes": 0

},

• ​

  "line1": "string",

• ​

  "line2": "string",

• ​

  "city": "string",

• ​

  "state": "string",

• ​

  "zip": "string",

• ​

  "care_type_id": 0,

• ​

  "campaign_name": "string"

}

}

Response samples

• ​200

application/json

Copy Expand all Collapse all

{

• ​

  "account_id": 0,

• ​

  "active_at": "2026-10-12T13:22:23Z",

• ​

  "close_reason_details": "string",

• ​

  "close_reason_id": 0,

• ​

  "community_id": 0,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "discarded_at": "2026-10-12T13:22:23Z",

• ​

  "discarded_by_id": 0,

• ​

  "expected_move_timing_id": 0,

• ​

  "id": 0,

• ​

  "initial_contact_at": "2026-10-12T13:22:23Z",

• ​

  "last_contact_at": "2026-10-12T13:22:23Z",

• ​

  "lead_source_id": 0,

• ​

  "metadata":

{

• ​

  "utm_campaign": "campaign-1",

• ​

  "utm_term": "senior living"

},

• ​

  "merged_into_prospect_id": 0,

• ​

  "next_activity_scheduled_at": "2026-10-12T13:22:23Z",

• ​

  "original_sales_counselor_id": 0,

• ​

  "referrer_id": 0,

• ​

  "sales_counselor_id": 0,

• ​

  "score_id": 0,

• ​

  "secondary_lead_source_id": 0,

• ​

  "stage_id": 0,

• ​

  "status": "open",

• ​

  "status_changed_at": "2026-10-12T13:22:23Z",

• ​

  "trait_ids": [ ],

• ​

  "updated_at": "2026-10-12T13:22:23Z",

• ​

  "residents_attributes":

[
\

• ​

  {
  \

  • ​"id": 0,
    \
  • ​"person_attributes":
    
    
    
    {
    \
    • ​"id": 0,
      \
    • ​"first_name": "string",
      \
    • ​"middle_name": "string",
      \
    • ​"last_name": "string",
      \
    • ​"cell_phone": "string",
      \
    • ​"home_phone": "string",
      \
    • ​"work_phone": "string",
      \
    • ​"email": "string",
      \
    • ​"fax_number": "string",
      \
    • ​"do_not_call": false,
      \
    • ​"do_not_email": false,
      \
    • ​"do_not_mail": false,
      \
    • ​"do_not_text": false,
      \
    • ​"birthdate": "string",
      \
    • ​"provided_age": 0,
      \
    • ​"gender": "male",
      \
    • ​"address_attributes":
      
      
      
      {
      \
      • ​"line1": "string",
        \
      • ​"line2": "string",
        \
      • ​"city": "string",
        \
      • ​"state": "string",
        \
      • ​"zip": "string"
        
        
        }
        
        },
        \
  • ​"care_type_id": 0,
    \
  • ​"marital_status": "single",
    \
  • ​"veteran_status": "unknown"
    
    
    }
    
    ],
• ​

  "influencers_attributes":

[
\

• ​

  {
  \

  • ​"id": 0,
    \
  • ​"person_attributes":
    
    
    
    {
    \
    • ​"id": 0,
      \
    • ​"first_name": "string",
      \
    • ​"middle_name": "string",
      \
    • ​"last_name": "string",
      \
    • ​"cell_phone": "string",
      \
    • ​"home_phone": "string",
      \
    • ​"work_phone": "string",
      \
    • ​"email": "string",
      \
    • ​"fax_number": "string",
      \
    • ​"do_not_call": false,
      \
    • ​"do_not_email": false,
      \
    • ​"do_not_mail": false,
      \
    • ​"do_not_text": false,
      \
    • ​"birthdate": "string",
      \
    • ​"provided_age": 0,
      \
    • ​"gender": "male",
      \
    • ​"address_attributes":
      
      
      
      {
      \
      • ​"line1": "string",
        \
      • ​"line2": "string",
        \
      • ​"city": "string",
        \
      • ​"state": "string",
        \
      • ​"zip": "string"
        
        
        }
        
        },
        \
  • ​"decision_maker": true,
    \
  • ​"health_care_proxy": true,
    \
  • ​"notes": "string",
    \
  • ​"point_of_contact": true,
    \
  • ​"power_of_attorney": true,
    \
  • ​"relationship_id": 0
    
    
    }
    
    ],
• ​

  "activity_attributes":

{

• ​

  "id": 0,

• ​

  "completed_at": "2026-10-12T13:22:23Z",

• ​

  "direction": "string",

• ​

  "notes": "string",

• ​

  "sales_counselor_id": 0,

• ​

  "scheduled_at": "2026-10-12T13:22:23Z",

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z",

• ​

  "record_type": "string",

• ​

  "record_id": 0,

• ​

  "stage_id": 0,

• ​

  "activity_type_id": 0,

• ​

  "discarded_at": "2026-10-12T13:22:23Z",

• ​

  "activity_result_id": 0,

• ​

  "pinned": true,

• ​

  "community_id": 0,

• ​

  "created_by_id": 0,

• ​

  "completed_successfully": true,

• ​

  "add_to_calendar": true,

• ​

  "time_zone": "Eastern Time (US & Canada)",

• ​

  "calendar_event_start_time": "14:00",

• ​

  "calendar_event_end_time": "15:00",

• ​

  "person_ids":

  [
  \

  • ​0
    
    
    ]

},

• ​"marketing_touchpoint_attributes":

{

• ​

  "id": 0,

• ​

  "lead_source_id": 0,

• ​

  "campaign_name": "string",

• ​

  "occurred_at": "2026-10-12T13:22:23Z"

}

}

List Names

query Parameters

Responses

200 Matching prospect IDs

get/prospects/names

Production Server

https://crm.welcomehomesoftware.com/api/prospects/names

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 1,
    \
  • ​"name": "string"
    
    
    }
    
    ]

Search for existing prospects

The search endpoint allows you to search for existing prospects.

This is particularly useful when wanting to check whether a prospect already exists in WelcomeHome in order to avoid creating duplicates.

The search finds exact (but case-insensitive) matches by name, email, and/or phone number.

The response includes several arrays, each containing the Prospect IDs of any matches:

• ​email_matches: Prospect IDs where at least one resident or influencer has a matching email address
• ​name_matches: Prospect IDs where at least one resident or influencer has a matching first and last name
• ​phone_number_matches: Prospect IDs where at least one resident or influencer has a matching cell, home, or work phone number

query Parameters

Responses

200 Matching prospect IDs

get/prospects/search

Production Server

https://crm.welcomehomesoftware.com/api/prospects/search

Response samples

• ​200

application/json

Copy Expand all Collapse all

{

• ​"email_matches":

[
\

• ​

  123
  
  
  ],

• ​

  "name_matches":

[
\

• ​

  111,
  \

• ​

  243
  
  
  ],

• ​

  "phone_number_matches": [ ]

}

Omni Search

This search is designed to be useful when wanting to provide autocomplete functionality.

The search finds fuzzy name and email matches, as well as prefix matches on phone numbers.

query Parameters

Responses

200 Matching Prospects

get/prospects/search/omni

Production Server

https://crm.welcomehomesoftware.com/api/prospects/search/omni

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"prospect_id": 0,
    \
  • ​"name": "string",
    \
  • ​"email": "string",
    \
  • ​"preferred_phone": "string"
    
    
    }
    
    ]

Show Prospect

The show prospects endpoint allows you to view a prospect in WelcomeHome.

path Parameters

Responses

200 Show a prospect

get/prospects/{id}

Production Server

https://crm.welcomehomesoftware.com/api/prospects/{id}

Response samples

• ​200

application/json

Copy Expand all Collapse all

{

• ​

  "account_id": 0,

• ​

  "active_at": "2026-10-12T13:22:23Z",

• ​

  "close_reason_details": "string",

• ​

  "close_reason_id": 0,

• ​

  "community_id": 0,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "discarded_at": "2026-10-12T13:22:23Z",

• ​

  "discarded_by_id": 0,

• ​

  "expected_move_timing_id": 0,

• ​

  "id": 0,

• ​

  "initial_contact_at": "2026-10-12T13:22:23Z",

• ​

  "last_contact_at": "2026-10-12T13:22:23Z",

• ​

  "lead_source_id": 0,

• ​

  "metadata":

{

• ​

  "utm_campaign": "campaign-1",

• ​

  "utm_term": "senior living"

},

• ​

  "merged_into_prospect_id": 0,

• ​

  "next_activity_scheduled_at": "2026-10-12T13:22:23Z",

• ​

  "original_sales_counselor_id": 0,

• ​

  "referrer_id": 0,

• ​

  "sales_counselor_id": 0,

• ​

  "score_id": 0,

• ​

  "secondary_lead_source_id": 0,

• ​

  "stage_id": 0,

• ​

  "status": "open",

• ​

  "status_changed_at": "2026-10-12T13:22:23Z",

• ​

  "trait_ids": [ ],

• ​

  "updated_at": "2026-10-12T13:22:23Z",

• ​

  "residents_attributes":

[
\

• ​

  {
  \

  • ​"id": 0,
    \
  • ​"person_attributes":
    
    
    
    {
    \
    • ​"id": 0,
      \
    • ​"first_name": "string",
      \
    • ​"middle_name": "string",
      \
    • ​"last_name": "string",
      \
    • ​"cell_phone": "string",
      \
    • ​"home_phone": "string",
      \
    • ​"work_phone": "string",
      \
    • ​"email": "string",
      \
    • ​"fax_number": "string",
      \
    • ​"do_not_call": false,
      \
    • ​"do_not_email": false,
      \
    • ​"do_not_mail": false,
      \
    • ​"do_not_text": false,
      \
    • ​"birthdate": "string",
      \
    • ​"provided_age": 0,
      \
    • ​"gender": "male",
      \
    • ​"address_attributes":
      
      
      
      {
      \
      • ​"line1": "string",
        \
      • ​"line2": "string",
        \
      • ​"city": "string",
        \
      • ​"state": "string",
        \
      • ​"zip": "string"
        
        
        }
        
        },
        \
  • ​"care_type_id": 0,
    \
  • ​"marital_status": "single",
    \
  • ​"veteran_status": "unknown"
    
    
    }
    
    ],
• ​

  "influencers_attributes":

[
\

• ​

  {
  \

  • ​"id": 0,
    \
  • ​"person_attributes":
    
    
    
    {
    \
    • ​"id": 0,
      \
    • ​"first_name": "string",
      \
    • ​"middle_name": "string",
      \
    • ​"last_name": "string",
      \
    • ​"cell_phone": "string",
      \
    • ​"home_phone": "string",
      \
    • ​"work_phone": "string",
      \
    • ​"email": "string",
      \
    • ​"fax_number": "string",
      \
    • ​"do_not_call": false,
      \
    • ​"do_not_email": false,
      \
    • ​"do_not_mail": false,
      \
    • ​"do_not_text": false,
      \
    • ​"birthdate": "string",
      \
    • ​"provided_age": 0,
      \
    • ​"gender": "male",
      \
    • ​"address_attributes":
      
      
      
      {
      \
      • ​"line1": "string",
        \
      • ​"line2": "string",
        \
      • ​"city": "string",
        \
      • ​"state": "string",
        \
      • ​"zip": "string"
        
        
        }
        
        },
        \
  • ​"decision_maker": true,
    \
  • ​"health_care_proxy": true,
    \
  • ​"notes": "string",
    \
  • ​"point_of_contact": true,
    \
  • ​"power_of_attorney": true,
    \
  • ​"relationship_id": 0
    
    
    }
    
    ],
• ​

  "prospect_field_values_attributes":

[
\

• ​{
  \
  • ​"prospect_field_id": 0,
    \
  • ​"value": "string"
    
    
    }
    
    ]

}

Update Prospect

path Parameters

Request Body schema: application/json

Responses

200 Show a prospect

put/prospects/{id}

Production Server

https://crm.welcomehomesoftware.com/api/prospects/{id}

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"prospect":

{

• ​

  "marketing_touchpoints_attributes":

  [
  \

  • ​{
    \
    • ​"id": 0,
      \
    • ​"lead_source_id": 0,
      \
    • ​"campaign_name": "string",
      \
    • ​"occurred_at": "2026-10-12T13:22:23Z"
      
      
      }
      
      ],
• ​

  "residents_attributes":

  [
  \

  • ​{
    \
    • ​"id": 0,
      \
    • ​"care_type_id": 0,
      \
    • ​"person_attributes":
      
      
      
      {
      \
      • ​"first_name": "string",
        \
      • ​"middle_name": "string",
        \
      • ​"last_name": "string",
        \
      • ​"cell_phone": "string",
        \
      • ​"home_phone": "string",
        \
      • ​"work_phone": "string",
        \
      • ​"email": "string",
        \
      • ​"fax_number": "string",
        \
      • ​"do_not_call": false,
        \
      • ​"do_not_email": false,
        \
      • ​"do_not_mail": false,
        \
      • ​"do_not_text": false,
        \
      • ​"birthdate": "string",
        \
      • ​"provided_age": 0,
        \
      • ​"gender": "male",
        \
      • ​"address_attributes":
        
        
        
        {
        \
        • ​"line1": "string",
          \
        • ​"line2": "string",
          \
        • ​"city": "string",
          \
        • ​"state": "string",
          \
        • ​"zip": "string"
          
          
          }
          
          }
          
          }
          
          ],
• ​

  "influencers_attributes":

  [
  \

  • ​{
    \
    • ​"id": 0,
      \
    • ​"notes": "string",
      \
    • ​"person_attributes":
      
      
      
      {
      \
      • ​"first_name": "string",
        \
      • ​"middle_name": "string",
        \
      • ​"last_name": "string",
        \
      • ​"cell_phone": "string",
        \
      • ​"home_phone": "string",
        \
      • ​"work_phone": "string",
        \
      • ​"email": "string",
        \
      • ​"fax_number": "string",
        \
      • ​"do_not_call": false,
        \
      • ​"do_not_email": false,
        \
      • ​"do_not_mail": false,
        \
      • ​"do_not_text": false,
        \
      • ​"birthdate": "string",
        \
      • ​"provided_age": 0,
        \
      • ​"gender": "male",
        \
      • ​"address_attributes":
        
        
        
        {
        \
        • ​"line1": "string",
          \
        • ​"line2": "string",
          \
        • ​"city": "string",
          \
        • ​"state": "string",
          \
        • ​"zip": "string"
          
          
          }
          
          },
          \
    • ​"relationship_id": 0
      
      
      }
      
      ],
• ​

  "expected_move_timing_id": 0,

• ​

  "lead_source_id": 0,

• ​

  "secondary_lead_source_id": 0,

• ​

  "metadata":

  {

  • ​

    "utm_campaign": "campaign-1",

  • ​

    "utm_term": "senior living"

},

• ​

  "notes": "string",

• ​

  "prospect_field_values_attributes":

  [
  \

  • ​{
    \
    • ​"prospect_field_id": 0,
      \
    • ​"value": "string"
      
      
      }
      
      ],
• ​

  "referrer_id": 0,

• ​

  "score_id": 0,

• ​

  "status": "open",

• ​

  "trait_ids":

  [
  \

  • ​0
    
    
    ]

}

}

Response samples

• ​200

application/json

Copy Expand all Collapse all

{

• ​

  "account_id": 0,

• ​

  "active_at": "2026-10-12T13:22:23Z",

• ​

  "close_reason_details": "string",

• ​

  "close_reason_id": 0,

• ​

  "community_id": 0,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "discarded_at": "2026-10-12T13:22:23Z",

• ​

  "discarded_by_id": 0,

• ​

  "expected_move_timing_id": 0,

• ​

  "id": 0,

• ​

  "initial_contact_at": "2026-10-12T13:22:23Z",

• ​

  "last_contact_at": "2026-10-12T13:22:23Z",

• ​

  "lead_source_id": 0,

• ​

  "metadata":

{

• ​

  "utm_campaign": "campaign-1",

• ​

  "utm_term": "senior living"

},

• ​

  "merged_into_prospect_id": 0,

• ​

  "next_activity_scheduled_at": "2026-10-12T13:22:23Z",

• ​

  "original_sales_counselor_id": 0,

• ​

  "referrer_id": 0,

• ​

  "sales_counselor_id": 0,

• ​

  "score_id": 0,

• ​

  "secondary_lead_source_id": 0,

• ​

  "stage_id": 0,

• ​

  "status": "open",

• ​

  "status_changed_at": "2026-10-12T13:22:23Z",

• ​

  "trait_ids": [ ],

• ​

  "updated_at": "2026-10-12T13:22:23Z",

• ​

  "residents_attributes":

[
\

• ​

  {
  \

  • ​"id": 0,
    \
  • ​"person_attributes":
    
    
    
    {
    \
    • ​"id": 0,
      \
    • ​"first_name": "string",
      \
    • ​"middle_name": "string",
      \
    • ​"last_name": "string",
      \
    • ​"cell_phone": "string",
      \
    • ​"home_phone": "string",
      \
    • ​"work_phone": "string",
      \
    • ​"email": "string",
      \
    • ​"fax_number": "string",
      \
    • ​"do_not_call": false,
      \
    • ​"do_not_email": false,
      \
    • ​"do_not_mail": false,
      \
    • ​"do_not_text": false,
      \
    • ​"birthdate": "string",
      \
    • ​"provided_age": 0,
      \
    • ​"gender": "male",
      \
    • ​"address_attributes":
      
      
      
      {
      \
      • ​"line1": "string",
        \
      • ​"line2": "string",
        \
      • ​"city": "string",
        \
      • ​"state": "string",
        \
      • ​"zip": "string"
        
        
        }
        
        },
        \
  • ​"care_type_id": 0,
    \
  • ​"marital_status": "single",
    \
  • ​"veteran_status": "unknown"
    
    
    }
    
    ],
• ​

  "influencers_attributes":

[
\

• ​

  {
  \

  • ​"id": 0,
    \
  • ​"person_attributes":
    
    
    
    {
    \
    • ​"id": 0,
      \
    • ​"first_name": "string",
      \
    • ​"middle_name": "string",
      \
    • ​"last_name": "string",
      \
    • ​"cell_phone": "string",
      \
    • ​"home_phone": "string",
      \
    • ​"work_phone": "string",
      \
    • ​"email": "string",
      \
    • ​"fax_number": "string",
      \
    • ​"do_not_call": false,
      \
    • ​"do_not_email": false,
      \
    • ​"do_not_mail": false,
      \
    • ​"do_not_text": false,
      \
    • ​"birthdate": "string",
      \
    • ​"provided_age": 0,
      \
    • ​"gender": "male",
      \
    • ​"address_attributes":
      
      
      
      {
      \
      • ​"line1": "string",
        \
      • ​"line2": "string",
        \
      • ​"city": "string",
        \
      • ​"state": "string",
        \
      • ​"zip": "string"
        
        
        }
        
        },
        \
  • ​"decision_maker": true,
    \
  • ​"health_care_proxy": true,
    \
  • ​"notes": "string",
    \
  • ​"point_of_contact": true,
    \
  • ​"power_of_attorney": true,
    \
  • ​"relationship_id": 0
    
    
    }
    
    ],
• ​

  "prospect_field_values_attributes":

[
\

• ​{
  \
  • ​"prospect_field_id": 0,
    \
  • ​"value": "string"
    
    
    }
    
    ]

}

List prospect attachments

path Parameters

Responses

200 list attachments

get/prospects/{prospect_id}/attachments

Production Server

https://crm.welcomehomesoftware.com/api/prospects/{prospect\_id}/attachments

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"attachment_url": "string",
    \
  • ​"byte_size": 0,
    \
  • ​"filename": "string",
    \
  • ​"title": "string",
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z",
    \
  • ​"discarded_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Create prospect attachment

Example Request:

curl https://crm.welcomehomesoftware.com/api/prospects/1/attachments \
  -H "Authorization: Token token={TOKEN}" \
  -F "attachment[file]=@path/to/file" \
  -F "attachment[title]=DocTitle"

Request Body schema: multipart/form-data

Responses

201 attachment

422 attachment

post/prospects/{prospect_id}/attachments

Production Server

https://crm.welcomehomesoftware.com/api/prospects/{prospect\_id}/attachments

Response samples

• ​201
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "attachment_url": "string",

• ​

  "byte_size": 0,

• ​

  "filename": "string",

• ​

  "title": "string",

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z",

• ​

  "discarded_at": "2026-10-12T13:22:23Z"

}

Relationships

List Relationships

Responses

200 list relationships

get/relationships

Production Server

https://crm.welcomehomesoftware.com/api/relationships

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"name": "Daughter",
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Residents

Show Resident

path Parameters

Responses

200 success

get/residents/{id}

Production Server

https://crm.welcomehomesoftware.com/api/residents/{id}

Response samples

• ​200

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "prospect_id": 0,

• ​

  "person_attributes":

{

• ​

  "id": 0,

• ​

  "first_name": "string",

• ​

  "middle_name": "string",

• ​

  "last_name": "string",

• ​

  "cell_phone": "string",

• ​

  "home_phone": "string",

• ​

  "work_phone": "string",

• ​

  "email": "string",

• ​

  "fax_number": "string",

• ​

  "do_not_call": false,

• ​

  "do_not_email": false,

• ​

  "do_not_mail": false,

• ​

  "do_not_text": false,

• ​

  "birthdate": "string",

• ​

  "provided_age": 0,

• ​

  "gender": "male",

• ​

  "address_attributes":

  {

  • ​

    "line1": "string",

  • ​

    "line2": "string",

  • ​

    "city": "string",

  • ​

    "state": "string",

  • ​

    "zip": "string"

}

},

• ​

  "care_type_id": 0,

• ​

  "marital_status": "single",

• ​

  "veteran_status": "unknown"

}

Update Resident

The residents endpoint allows you to update certain data points for residents in WelcomeHome.

The permitted data points relate to marital status, birthdate, age, gender, and address.

Request Body schema: application/json

Responses

200 success

422 unprocessable_entity

put/residents/{id}

Production Server

https://crm.welcomehomesoftware.com/api/residents/{id}

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"resident":

{

• ​

  "care_type_id": 0,

• ​

  "marital_status": "single",

• ​

  "person_attributes":

  {

  • ​

    "first_name": "string",

  • ​

    "middle_name": "string",

  • ​

    "last_name": "string",

  • ​

    "cell_phone": "string",

  • ​

    "home_phone": "string",

  • ​

    "work_phone": "string",

  • ​

    "email": "string",

  • ​

    "fax_number": "string",

  • ​

    "do_not_call": false,

  • ​

    "do_not_email": false,

  • ​

    "do_not_mail": false,

  • ​

    "do_not_text": false,

  • ​

    "birthdate": "string",

  • ​

    "provided_age": 0,

  • ​

    "gender": "male",

  • ​

    "address_attributes":

    {

    • ​

      "line1": "string",

    • ​

      "line2": "string",

    • ​

      "city": "string",

    • ​

      "state": "string",

    • ​

      "zip": "string"

}

},

• ​"veteran_status": "unknown"

}

}

Response samples

• ​200
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "prospect_id": 0,

• ​

  "person_attributes":

{

• ​

  "id": 0,

• ​

  "first_name": "string",

• ​

  "middle_name": "string",

• ​

  "last_name": "string",

• ​

  "cell_phone": "string",

• ​

  "home_phone": "string",

• ​

  "work_phone": "string",

• ​

  "email": "string",

• ​

  "fax_number": "string",

• ​

  "do_not_call": false,

• ​

  "do_not_email": false,

• ​

  "do_not_mail": false,

• ​

  "do_not_text": false,

• ​

  "birthdate": "string",

• ​

  "provided_age": 0,

• ​

  "gender": "male",

• ​

  "address_attributes":

  {

  • ​

    "line1": "string",

  • ​

    "line2": "string",

  • ​

    "city": "string",

  • ​

    "state": "string",

  • ​

    "zip": "string"

}

},

• ​

  "care_type_id": 0,

• ​

  "marital_status": "single",

• ​

  "veteran_status": "unknown"

}

Scores

List Scores

Responses

200 list scores

get/scores

Production Server

https://crm.welcomehomesoftware.com/api/scores

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"name": "string",
    \
  • ​"position": 0,
    \
  • ​"for_referrers": true,
    \
  • ​"for_prospects": true,
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Stages

List Stages

Responses

200 list stages

get/stages

Production Server

https://crm.welcomehomesoftware.com/api/stages

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"name": "New Lead",
    \
  • ​"position": 0,
    \
  • ​"system_type": "new_lead",
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Traits

List Traits

Responses

200 list traits

get/traits

Production Server

https://crm.welcomehomesoftware.com/api/traits

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"name": "Affordability",
    \
  • ​"trait_category":
    
    
    
    {
    \
    • ​"id": 0,
      \
    • ​"name": "Decision Criteria"
      
      
      },
      \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Unit Market Rates

List Unit Market Rates

path Parameters

Responses

200 market rates

404 unit not found

get/units/{unit_id}/market_rates

Production Server

https://crm.welcomehomesoftware.com/api/units/{unit\_id}/market\_rates

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"start_date": "2026-10-12",
    \
  • ​"market_rate": null,
    \
  • ​"second_resident_market_rate": null,
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Create Unit Market Rate

Omitted rates default to zero.

path Parameters

Request Body schema: application/json

Responses

201 market rate

404 unit not found

422 invalid market rate

post/units/{unit_id}/market_rates

Production Server

https://crm.welcomehomesoftware.com/api/units/{unit\_id}/market\_rates

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"market_rate":

{

• ​

  "start_date": "2026-10-12",

• ​

  "market_rate": null,

• ​

  "second_resident_market_rate": null

}

}

Response samples

• ​201
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "start_date": "2026-10-12",

• ​

  "market_rate": null,

• ​

  "second_resident_market_rate": null,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Update Unit Market Rate

path Parameters

Request Body schema: application/json

Responses

200 market rate

404 unit or market rate not found

422 invalid market rate

put/units/{unit_id}/market_rates/{id}

Production Server

https://crm.welcomehomesoftware.com/api/units/{unit\_id}/market\_rates/{id}

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"market_rate":

{

• ​

  "start_date": "2026-10-12",

• ​

  "market_rate": null,

• ​

  "second_resident_market_rate": null

}

}

Response samples

• ​200
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "start_date": "2026-10-12",

• ​

  "market_rate": null,

• ​

  "second_resident_market_rate": null,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Delete Unit Market Rate

path Parameters

Responses

204 market rate deleted

404 unit or market rate not found

delete/units/{unit_id}/market_rates/{id}

Production Server

https://crm.welcomehomesoftware.com/api/units/{unit\_id}/market\_rates/{id}

Units

List Units

query Parameters

Responses

200 list units

get/units

Production Server

https://crm.welcomehomesoftware.com/api/units

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"number": "string",
    \
  • ​"floor": "string",
    \
  • ​"amenities":
    
    
    
    [
    \
    • ​"string"
      
      
      ],
      \
  • ​"care_type_id": 0,
    \
  • ​"community_id": 0,
    \
  • ​"default_privacy_level_id": 0,
    \
  • ​"floor_plan_id": 0,
    \
  • ​"notes": "string",
    \
  • ​"off_census": true,
    \
  • ​"square_feet": 0,
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"discarded_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z",
    \
  • ​"market_rate": 0,
    \
  • ​"second_resident_market_rate": 0
    
    
    }
    
    ]

Create Unit

Request Body schema: application/json

Responses

201 created

422 unprocessable_entity

post/units

Production Server

https://crm.welcomehomesoftware.com/api/units

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"unit":

{

• ​

  "community_id": 0,

• ​

  "number": "string",

• ​

  "floor": "string",

• ​

  "floor_plan_id": 0,

• ​

  "care_type_id": 0,

• ​

  "default_privacy_level_id": 0,

• ​

  "square_feet": 0,

• ​

  "off_census": true,

• ​

  "notes": "string",

• ​

  "amenities":

  [
  \

  • ​"string"
    
    
    ]

}

}

Response samples

• ​201
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "number": "string",

• ​

  "floor": "string",

• ​

  "amenities":

[
\

• ​

  "string"
  
  
  ],

• ​

  "care_type_id": 0,

• ​

  "community_id": 0,

• ​

  "default_privacy_level_id": 0,

• ​

  "floor_plan_id": 0,

• ​

  "notes": "string",

• ​

  "off_census": true,

• ​

  "square_feet": 0,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "discarded_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Show Unit

path Parameters

query Parameters

Responses

200 show unit

get/units/{id}

Production Server

https://crm.welcomehomesoftware.com/api/units/{id}

Response samples

• ​200

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "number": "string",

• ​

  "floor": "string",

• ​

  "amenities":

[
\

• ​

  "string"
  
  
  ],

• ​

  "care_type_id": 0,

• ​

  "community_id": 0,

• ​

  "default_privacy_level_id": 0,

• ​

  "floor_plan_id": 0,

• ​

  "notes": "string",

• ​

  "off_census": true,

• ​

  "square_feet": 0,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "discarded_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z",

• ​

  "market_rate": 0,

• ​

  "second_resident_market_rate": 0

}

Update Unit

path Parameters

Request Body schema: application/json

Responses

200 ok

422 unprocessable_entity

put/units/{id}

Production Server

https://crm.welcomehomesoftware.com/api/units/{id}

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"unit":

{

• ​

  "number": "string",

• ​

  "floor": "string",

• ​

  "floor_plan_id": 0,

• ​

  "care_type_id": 0,

• ​

  "default_privacy_level_id": 0,

• ​

  "square_feet": 0,

• ​

  "off_census": true,

• ​

  "notes": "string",

• ​

  "amenities":

  [
  \

  • ​"string"
    
    
    ]

}

}

Response samples

• ​200
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "number": "string",

• ​

  "floor": "string",

• ​

  "amenities":

[
\

• ​

  "string"
  
  
  ],

• ​

  "care_type_id": 0,

• ​

  "community_id": 0,

• ​

  "default_privacy_level_id": 0,

• ​

  "floor_plan_id": 0,

• ​

  "notes": "string",

• ​

  "off_census": true,

• ​

  "square_feet": 0,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "discarded_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

User Roles

List User Roles

query Parameters

Responses

200 success

get/user_roles

Production Server

https://crm.welcomehomesoftware.com/api/user\_roles

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"community_id": 0,
    \
  • ​"user_id": 0,
    \
  • ​"role": "sales_director",
    \
  • ​"title": "string",
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Create User Role

Request Body schema: application/json

Responses

201 success

422 unprocessable_entity

post/user_roles

Production Server

https://crm.welcomehomesoftware.com/api/user\_roles

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"user_role":

{

• ​

  "community_id": 0,

• ​

  "user_id": 0,

• ​

  "role": "sales_director",

• ​

  "title": "string"

}

}

Response samples

• ​201
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "community_id": 0,

• ​

  "user_id": 0,

• ​

  "role": "sales_director",

• ​

  "title": "string",

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Show User Role

path Parameters

Responses

200 success

get/user_roles/{id}

Production Server

https://crm.welcomehomesoftware.com/api/user\_roles/{id}

Response samples

• ​200

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "community_id": 0,

• ​

  "user_id": 0,

• ​

  "role": "sales_director",

• ​

  "title": "string",

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Update User Role

Request Body schema: application/json

Responses

200 success

422 unprocessable_entity

put/user_roles/{id}

Production Server

https://crm.welcomehomesoftware.com/api/user\_roles/{id}

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"user_role":

{

• ​

  "community_id": 0,

• ​

  "user_id": 0,

• ​

  "role": "sales_director",

• ​

  "title": "string"

}

}

Response samples

• ​200
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "community_id": 0,

• ​

  "user_id": 0,

• ​

  "role": "sales_director",

• ​

  "title": "string",

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Delete User Role

path Parameters

Responses

204 success

404 not_found

delete/user_roles/{id}

Production Server

https://crm.welcomehomesoftware.com/api/user\_roles/{id}

Response samples

• ​204
• ​404

application/json

Copy Expand all Collapse all

null

Phone Numbers

List Phone Numbers

Requires an API Token with access to all communities

path Parameters

Responses

200 list phone_numbers

get/users/{user_id}/phone_numbers

Production Server

https://crm.welcomehomesoftware.com/api/users/{user\_id}/phone\_numbers

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"number": "string",
    \
  • ​"label": "string",
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Create Phone Number

Requires an API Token with access to all communities

path Parameters

Request Body schema: application/json

Responses

201 phone_number

422 phone_number

post/users/{user_id}/phone_numbers

Production Server

https://crm.welcomehomesoftware.com/api/users/{user\_id}/phone\_numbers

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"phone_number":

{

• ​

  "number": "string",

• ​

  "label": "string"

}

}

Response samples

• ​201
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "number": "string",

• ​

  "label": "string",

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Show Phone Number

Requires an API Token with access to all communities

path Parameters

Responses

200 phone_number

get/users/{user_id}/phone_numbers/{id}

Production Server

https://crm.welcomehomesoftware.com/api/users/{user\_id}/phone\_numbers/{id}

Response samples

• ​200

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "number": "string",

• ​

  "label": "string",

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Update Phone Number

Requires an API Token with access to all communities

path Parameters

Request Body schema: application/json

Responses

200 phone_number

422 phone_number

put/users/{user_id}/phone_numbers/{id}

Production Server

https://crm.welcomehomesoftware.com/api/users/{user\_id}/phone\_numbers/{id}

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"phone_number":

{

• ​

  "number": "string",

• ​

  "label": "string"

}

}

Response samples

• ​200
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "number": "string",

• ​

  "label": "string",

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Delete Phone Number

Requires an API Token with access to all communities

path Parameters

Responses

204 phone_number

404 phone_number

delete/users/{user_id}/phone_numbers/{id}

Production Server

https://crm.welcomehomesoftware.com/api/users/{user\_id}/phone\_numbers/{id}

Response samples

• ​204
• ​404

application/json

Copy Expand all Collapse all

null

Users

List Users

Requires an API Token with access to all communities

Responses

200 list users

get/users

Production Server

https://crm.welcomehomesoftware.com/api/users

Response samples

• ​200

application/json

Copy Expand all Collapse all

[
\

• ​{
  \
  • ​"id": 0,
    \
  • ​"email": "string",
    \
  • ​"first_name": "string",
    \
  • ​"last_name": "string",
    \
  • ​"role": "user",
    \
  • ​"community_ids":
    
    
    
    [
    \
    • ​0
      
      
      ],
      \
  • ​"all_communities": true,
    \
  • ​"created_at": "2026-10-12T13:22:23Z",
    \
  • ​"deactivated_at": "2026-10-12T13:22:23Z",
    \
  • ​"updated_at": "2026-10-12T13:22:23Z"
    
    
    }
    
    ]

Create User

Requires an API Token with access to all communities

Request Body schema: application/json

Responses

201 user

422 user

post/users

Production Server

https://crm.welcomehomesoftware.com/api/users

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"user":

{

• ​

  "email": "string",

• ​

  "first_name": "string",

• ​

  "last_name": "string",

• ​

  "role": "user",

• ​

  "community_ids":

  [
  \

  • ​0
    
    
    ],
• ​

  "all_communities": true

}

}

Response samples

• ​201
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "email": "string",

• ​

  "first_name": "string",

• ​

  "last_name": "string",

• ​

  "role": "user",

• ​

  "community_ids":

[
\

• ​

  0
  
  
  ],

• ​

  "all_communities": true,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "deactivated_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Show User

Requires an API Token with access to all communities

path Parameters

Responses

200 user

get/users/{id}

Production Server

https://crm.welcomehomesoftware.com/api/users/{id}

Response samples

• ​200

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "email": "string",

• ​

  "first_name": "string",

• ​

  "last_name": "string",

• ​

  "role": "user",

• ​

  "community_ids":

[
\

• ​

  0
  
  
  ],

• ​

  "all_communities": true,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "deactivated_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Update User

Requires an API Token with access to all communities

Request Body schema: application/json

Responses

200 user

422 user

put/users/{id}

Production Server

https://crm.welcomehomesoftware.com/api/users/{id}

Request samples

• ​Payload

application/json

Copy Expand all Collapse all

{

• ​"user":

{

• ​

  "email": "string",

• ​

  "first_name": "string",

• ​

  "last_name": "string",

• ​

  "role": "user",

• ​

  "community_ids":

  [
  \

  • ​0
    
    
    ],
• ​

  "all_communities": true

}

}

Response samples

• ​200
• ​422

application/json

Copy Expand all Collapse all

{

• ​

  "id": 0,

• ​

  "email": "string",

• ​

  "first_name": "string",

• ​

  "last_name": "string",

• ​

  "role": "user",

• ​

  "community_ids":

[
\

• ​

  0
  
  
  ],

• ​

  "all_communities": true,

• ​

  "created_at": "2026-10-12T13:22:23Z",

• ​

  "deactivated_at": "2026-10-12T13:22:23Z",

• ​

  "updated_at": "2026-10-12T13:22:23Z"

}

Deactivate User

Requires an API Token with access to all communities

Responses

200 user

put/users/{id}/deactivate

Production Server

https://crm.welcomehomesoftware.com/api/users/{id}/deactivate

Reactivate User

Requires an API Token with access to all communities

Responses

200 user

put/users/{id}/reactivate

Production Server

https://crm.welcomehomesoftware.com/api/users/{id}/reactivate