### Metadata example Source: https://crm.welcomehomesoftware.com/api-docs/v1/swagger.yaml Example JSON structure for the metadata field used to track marketing parameters. ```json utm_campaign: campaign-1 utm_term: senior living ``` -------------------------------- ### GET /stages Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieves a list of all stages available in the system. ```APIDOC ## GET /stages ### Description List all stages. ### Method GET ### Endpoint /stages ### Response #### Success Response (200) - **id** (integer) - Stage ID - **name** (string) - Stage name - **position** (integer) - Display position - **system_type** (string) - System type identifier - **created_at** (string) - Creation timestamp - **updated_at** (string) - Last update timestamp #### Response Example [ { "id": 0, "name": "New Lead", "position": 0, "system_type": "new_lead", "created_at": "string", "updated_at": "string" } ] ``` -------------------------------- ### GET /users Source: https://crm.welcomehomesoftware.com/api-docs/index.html Lists all users. ```APIDOC ## GET /users ### Description Lists all users. ### Method GET ### Endpoint https://crm.welcomehomesoftware.com/api/users ### Response #### Success Response (200) - **list users** (array) - A list of user objects. #### Response Example [ { "id": 0, "email": "string", "first_name": "string", "last_name": "string", "role": "user", "community_ids": [0], "all_communities": true, "created_at": "2000-01-01T12:00:00.000Z", "deactivated_at": null, "updated_at": "2000-01-01T12:00:00.000Z" } ] ``` -------------------------------- ### GET /lead_sources Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieves a list of all available lead sources in the system. ```APIDOC ## GET /lead_sources ### Description Retrieves a list of all lead sources. ### Method GET ### Endpoint /lead_sources ### Response #### Success Response (200) - **id** (integer) - Lead source ID - **name** (string) - Name of the lead source #### Response Example [ { "id": 0, "name": "string" } ] ``` -------------------------------- ### List Activities Response Sample Source: https://crm.welcomehomesoftware.com/api-docs/index.html Example JSON response structure for the list activities endpoint. ```json [ { "id": 0, "completed_at": null, "direction": "string", "notes": "string", "sales_counselor_id": 0, "scheduled_at": null, "created_at": "string", "updated_at": "string", "record_type": "string", "record_id": 0, "stage_id": 0, "activity_type_id": 0, "discarded_at": null, "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 ] } ] ``` -------------------------------- ### Datetime example Source: https://crm.welcomehomesoftware.com/api-docs/v1/swagger.yaml Standard ISO 8601 format used for attachment timestamps. ```text '2000-01-01T12:00:00.000Z' ``` -------------------------------- ### GET /traits Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieves a list of all traits available in the system. ```APIDOC ## GET /traits ### Description List all traits. ### Method GET ### Endpoint /traits ### Response #### Success Response (200) - **id** (integer) - Trait ID - **name** (string) - Trait name - **trait_category** (object) - Category details - **created_at** (string) - Creation timestamp - **updated_at** (string) - Last update timestamp #### Response Example [ { "id": 0, "name": "Affordability", "trait_category": { "id": 0, "name": "Decision Criteria" }, "created_at": "string", "updated_at": "string" } ] ``` -------------------------------- ### Handle API Authentication Responses Source: https://crm.welcomehomesoftware.com/api-docs/index.html Examples of successful and failed authentication or authorization responses. ```json {"account_id":2,"lead_source_id":null} ``` ```json {"error":"Bad credentials"} ``` ```json {"error":"Not authorized to perform this action"} ``` -------------------------------- ### GET /activities Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieve a list of activities with optional filtering and pagination. ```APIDOC ## GET /activities ### Description Returns a paginated list of activities based on provided filters. ### Method GET ### Endpoint /api/activities ### Parameters #### Query Parameters - **limit** (integer) - Optional - Numbers of records to return per page (Default: 10, Max: 100). - **filters[activity_type_id]** (integer) - Optional - Activity Type ID to search on. - **filters[created_at_after]** (string) - Optional - Filter by creation date (ISO 8601). - **filters[created_at_before]** (string) - Optional - Filter by creation date (ISO 8601). - **filters[updated_at_after]** (string) - Optional - Filter by update date (ISO 8601). - **filters[updated_at_before]** (string) - Optional - Filter by update date (ISO 8601). ### Response #### Success Response (200) - **id** (integer) - Activity ID - **notes** (string) - Activity notes - **created_at** (string) - Creation timestamp #### Response Example [ { "id": 0, "notes": "string", "created_at": "string" } ] ``` -------------------------------- ### GET /floor_plans Source: https://crm.welcomehomesoftware.com/api-docs/v1/swagger.yaml Lists available floor plans. This endpoint can be filtered by community ID. ```APIDOC ## GET /floor_plans ### Description Lists available floor plans. This endpoint can be filtered by community ID. ### Method GET ### Endpoint /floor_plans ### Parameters #### Query Parameters - **filters[community_id]** (integer) - Optional - Example: '1' ### Responses #### Success Response (200) - Description: list floor plans - Content: - **id** (integer) - **community_id** (integer) - **name** (string) - **square_feet** (integer) - **beds** (integer) - **baths** (decimal) - **occupancy_points** (decimal) - **default_privacy_level_id** (integer) - **created_at** (timestamp) - **updated_at** (timestamp) ``` -------------------------------- ### GET /relationships Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieves a list of all available relationship types. ```APIDOC ## GET /relationships ### Description Retrieves a list of all available relationship types. ### Method GET ### Endpoint /relationships ### Response #### Success Response (200) - **id** (integer) - Relationship ID - **name** (string) - Name of the relationship #### Response Example [ { "id": 0, "name": "Daughter", "created_at": "string", "updated_at": "string" } ] ``` -------------------------------- ### GET /prospects/{prospect_id}/activities Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieves a list of activities for a specific prospect. ```APIDOC ## GET /prospects/{prospect_id}/activities ### Description Retrieves a list of all activities associated with a given prospect. ### Method GET ### Endpoint https://crm.welcomehomesoftware.com/api/prospects/{prospect_id}/activities ### Parameters #### Path Parameters - **prospect_id** (integer) - Required - The unique identifier of the prospect. ### Response #### Success Response (200) - **id** (integer) - Activity ID - **completed_at** (string/null) - Completion timestamp - **direction** (string) - Direction of activity - **notes** (string) - Activity notes - **sales_counselor_id** (integer) - ID of the assigned sales counselor - **scheduled_at** (string/null) - Scheduled timestamp - **created_at** (string) - Creation timestamp - **updated_at** (string) - Last update timestamp - **record_type** (string) - Type of record - **record_id** (integer) - Record ID - **stage_id** (integer) - Stage ID - **activity_type_id** (integer) - Activity type ID - **discarded_at** (string/null) - Discarded timestamp - **activity_result_id** (integer) - Result ID - **pinned** (boolean) - Whether the activity is pinned - **community_id** (integer) - Community ID - **created_by_id** (integer) - ID of the creator - **completed_successfully** (boolean) - Success status - **add_to_calendar** (boolean) - Calendar sync status - **time_zone** (string) - Time zone - **calendar_event_start_time** (string) - Start time - **calendar_event_end_time** (string) - End time - **person_ids** (array) - List of associated person IDs ``` -------------------------------- ### GET /prospects/{id} Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieve detailed information for a specific prospect by their ID. ```APIDOC ## GET /prospects/{id} ### Description Allows you to view a specific prospect in WelcomeHome. ### Method GET ### Endpoint https://crm.welcomehomesoftware.com/api/prospects/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The unique identifier of the prospect ``` -------------------------------- ### GET /housing_contracts Source: https://crm.welcomehomesoftware.com/api-docs/v1/swagger.yaml Lists housing contracts. No additional details provided in the source text. ```APIDOC ## GET /housing_contracts ### Description Lists Housing Contracts. ### Method GET ### Endpoint /housing_contracts ``` -------------------------------- ### Create Activity Source: https://crm.welcomehomesoftware.com/api-docs/v1/swagger.yaml Creates a new activity. To add a start and end time to a calendar event, `"add_to_calendar": true` must be passed along with `time_zone`, `calendar_event_start_time`, and `calendar_event_end_time`. ```APIDOC ## POST /activities ### Description Creates a new activity. To add a start and end time to a calendar event, `"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"] ### Method POST ### Endpoint /activities ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **activity** (object) - Required - The activity object containing details. - **activity_result_id** (integer) - Optional - The ID of the activity result. ### Request Example ```json { "activity": { "activity_result_id": 1, "add_to_calendar": true, "time_zone": "Eastern Time (US & Canada)", "calendar_event_start_time": "3:00 PM", "calendar_event_end_time": "4:00 PM", "notes": "Initial meeting", "scheduled_at": "2023-11-15T10:00:00Z", "person_ids": [101, 102] } } ``` ### Response #### Success Response (200) - **id** (integer) - Unique identifier for the activity. - **completed_at** (datetime) - The timestamp when the activity was completed. - **direction** (string) - The direction of the activity (e.g., inbound, outbound). - **notes** (string) - Any notes associated with the activity. - **sales_counselor_id** (integer) - The ID of the sales counselor associated with the activity. - **scheduled_at** (datetime) - The timestamp when the activity is scheduled. - **created_at** (string) - The timestamp when the activity was created. - **updated_at** (string) - The timestamp when the activity was last updated. - **record_type** (string) - The type of record the activity is associated with. - **record_id** (integer) - The ID of the record the activity is associated with. - **stage_id** (integer) - The ID of the stage the activity belongs to. - **activity_type_id** (integer) - The ID of the activity type. - **discarded_at** (datetime) - The timestamp when the activity was discarded. - **activity_result_id** (integer) - The ID of the activity result. - **pinned** (boolean) - Indicates if the activity is pinned. - **community_id** (integer) - The ID of the community associated with the activity. - **created_by_id** (integer) - The ID of the user who created the activity. - **completed_successfully** (boolean) - Indicates if the activity was completed successfully. - **time_zone** (string) - The time zone for calendar events. Example: "Eastern Time (US & Canada)". - **calendar_event_start_time** (string) - The start time for calendar events. Example: "14:00". - **calendar_event_end_time** (string) - The end time for calendar events. Example: "15:00". - **person_ids** (array of integers) - A list of IDs of people associated with the activity. #### Response Example ```json { "id": 2, "completed_at": null, "direction": "outbound", "notes": "Initial meeting", "sales_counselor_id": 101, "scheduled_at": "2023-11-15T10:00:00Z", "created_at": "2023-11-14T15:30:00Z", "updated_at": "2023-11-14T15:30:00Z", "record_type": "lead", "record_id": 202, "stage_id": 1, "activity_type_id": 1, "discarded_at": null, "activity_result_id": 1, "pinned": false, "community_id": 5, "created_by_id": 101, "completed_successfully": false, "time_zone": "Eastern Time (US & Canada)", "calendar_event_start_time": "15:00", "calendar_event_end_time": "16:00", "person_ids": [101, 102] } ``` ``` -------------------------------- ### Create Prospect Attachment Request Source: https://crm.welcomehomesoftware.com/api-docs/index.html Example cURL request to upload a file attachment to a prospect using multipart/form-data. ```bash curl https://crm.welcomehomesoftware.com/api/prospects/1/attachments \ -H "Authorization: Token token={TOKEN}" \ -F "attachment[file]=@path/to/file" \ -F "attachment[title]=DocTitle" ``` -------------------------------- ### Live, paginated CSV data export Source: https://crm.welcomehomesoftware.com/api-docs/v1/swagger.yaml This endpoint provides live, paginated bulk export capability. It is the most efficient way to get a full data dump out of WelcomeHome and can be used to poll for changes by filtering based on `updated_at`. By default, this endpoint returns 1000 results per page. 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. All timestamps are in UTC unless otherwise specified. ```APIDOC ## GET /exports/community/{community_id}/table/{table} ### Description Provides live, paginated bulk export of data from a specified table within a community. ### Method GET ### Endpoint /exports/community/{community_id}/table/{table} ### Parameters #### Path Parameters - **community_id** (string) - Required - A community ID or `all` for all communities. - **table** (string) - Required - The table to export. Must be one of: `Organizations`, `Referrers`, `Prospects`, `ProspectFields`, `Residents`, `Influencers`, `Activities`, `ExternalReferences`, `Units`, `HousingContracts`, `DepositTransactions`, `MarketingTouchpoints`, `ServiceAgreements`, `Traits`, `Users`, `WaitlistEntries`. Case-sensitive. #### Query Parameters - **sort_by** (string) - Optional - Column to sort by. Defaults to `updated_at`. Can also be `created_at`. - **limit** (integer) - Optional - Numbers of records to return per page. Defaults to 1000. ### Response #### Success Response (200) - **CSV Data** - The response will be in CSV format, containing the requested data. - **Link Header** - If more records are available, this header will contain a URL to fetch the next page. ### Notes - Cursors used for pagination are limited to 3 uses per minute to prevent infinite pulls. - All timestamps are in UTC. ``` -------------------------------- ### GET /exports/daily_snapshots/table/{table} Source: https://crm.welcomehomesoftware.com/api-docs/v1/swagger.yaml Retrieves a daily snapshot of CSV data for a specified table. This endpoint is suitable for BI integrations where daily frequency is sufficient and pagination is cumbersome. Contact support@welcomehomesoftware.com to activate this endpoint. Requires an API Token with access to all communities. All timestamps are in UTC. ```APIDOC ## GET /exports/daily_snapshots/table/{table} ### Description 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 support@welcomehomesoftware.com 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 and pagination is difficult or cumbersome. Requires an API Token with access to all communities. All timestamps are in UTC unless otherwise specified. ### Method GET ### Endpoint /exports/daily_snapshots/table/{table} ### Parameters #### Path Parameters - **table** (string) - Required - The table to export. One of: Organizations, Referrers, Prospects, ProspectFields, Residents, Influencers, Activities, ExternalReferences, Units, HousingContracts, DepositTransactions, MarketingTouchpoints, ServiceAgreements, Traits, Users, WaitlistEntries. Note the capitalization of the table names. The values are case-sensitive. #### Query Parameters - **direct** (string) - Optional - Set to `true` to receive the file content directly instead of a redirect. By default, this endpoint redirects to a signed S3 URL, which is the most efficient approach. However, some clients (such as Azure Data Factory) cannot follow HTTP redirects. For these clients, `direct=true` streams the file through our servers instead. Note: We suggest only using the direct option if necessary. - **limit** (integer) - Optional - Default: `1000`. Maximum: `10000`. - **filters[created_at_after]** (string) - Optional - Example: '2000-01-01T00:00:00Z' - **filters[created_at_before]** (string) - Optional - Example: '2000-01-01T00:00:00Z' - **filters[updated_at_after]** (string) - Optional - Example: '2000-01-01T00:00:00Z' - **filters[updated_at_before]** (string) - Optional - Example: '2000-01-01T00:00:00Z' ### Responses #### Success Response (301) - Description: Redirect to CSV location (default) #### Success Response (200) - Description: CSV content (when direct=true) - Headers: - **Link** (string) - 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: ; 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. ``` -------------------------------- ### GET /communities Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieves a list of all communities. ```APIDOC ## GET /communities ### Description Retrieves a list of all communities. ### Method GET ### Endpoint /communities ### Response #### Success Response (200) - **id** (integer) - Unique identifier - **name** (string) - Name of the community - **created_at** (string) - Creation timestamp - **updated_at** (string) - Last update timestamp #### Response Example [ { "id": 0, "name": "Community Name", "created_at": "string", "updated_at": "string" } ] ``` -------------------------------- ### GET /exports/community/{community_id}/table/{table} Source: https://crm.welcomehomesoftware.com/api-docs/index.html Provides live, paginated bulk export of data. This is the most efficient way to get a full data dump and can be used to poll for changes using `updated_at` filters. Returns 1000 results per page by default. ```APIDOC ## GET /exports/community/{community_id}/table/{table} ### Description 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`. 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. 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. ### Method GET ### Endpoint /exports/community/{community_id}/table/{table} ### Parameters #### Path Parameters - **community_id** (string) - Required - A community ID or `all` for all communities - **table** (string) - Required - The table to export. One of: Organizations, Referrers, Prospects, ProspectFields, Residents, Influencers, Activities, ExternalReferences, Units, HousingContracts, DepositTransactions, MarketingTouchpoints, ServiceAgreements, Traits, Users, WaitlistEntries. Note the capitalization of the table names. The values are case-sensitive. #### Query Parameters - **sort_by** (string) - Optional - Column to sort by: `updated_at` (default), `created_at`. - **limit** (integer) - Optional - Numbers of records to return per page. Default: `1000`. Maximum: `10000`. - **filters[created_at_after]** (string) - Optional - Example: "2000-01-01T00:00:00Z" - **filters[created_at_before]** (string) - Optional - Example: "2000-01-01T00:00:00Z" - **filters[updated_at_after]** (string) - Optional - Example: "2000-01-01T00:00:00Z" - **filters[updated_at_before]** (string) - Optional - Example: "2000-01-01T00:00:00Z" ### Responses #### Success Response (200) - **CSV** (string) - Description: Returns data in CSV format. See response details below to learn about pagination. #### Response Example (CSV data would be returned here, with a 'Link' header for pagination if applicable) ### Headers - **Link** (string) - Present if there are more pages of results. Example: `; rel="next"` ``` -------------------------------- ### GET /relationships Source: https://crm.welcomehomesoftware.com/api-docs/v1/swagger.yaml Retrieves a list of all relationships associated with the CRM. ```APIDOC ## GET /relationships ### Description Retrieves a list of all relationships. ### Method GET ### Endpoint /relationships ### Parameters None ### Request Example None ### Response #### Success Response (200) - **id** (integer) - Unique identifier for the relationship. - **name** (string) - The name of the relationship (e.g., Daughter). - **created_at** (string) - Timestamp when the relationship was created. - **updated_at** (string) - Timestamp when the relationship was last updated. #### Response Example { "example": "[ { "id": 1, "name": "Daughter", "created_at": "2000-01-01T12:00:00.000Z", "updated_at": "2000-01-01T12:00:00.000Z" } ]" } ``` -------------------------------- ### Response Sample for Create Event Source: https://crm.welcomehomesoftware.com/api-docs/index.html This JSON object represents a sample response after successfully creating an event. It includes all the details of the created event, along with creation and update timestamps. ```json { "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": null, "updated_at": null } ``` -------------------------------- ### GET /users/{id} Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieves details of a specific user. ```APIDOC ## GET /users/{id} ### Description Retrieves details of a specific user. ### Method GET ### Endpoint https://crm.welcomehomesoftware.com/api/users/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the user. ### Response #### Success Response (200) - **user** (object) - The user details. ``` -------------------------------- ### POST /users Source: https://crm.welcomehomesoftware.com/api-docs/index.html Creates a new user. ```APIDOC ## POST /users ### Description Creates a new user. ### Method POST ### Endpoint https://crm.welcomehomesoftware.com/api/users ### Parameters #### Request Body - **user** (object) - Required - Object containing user details. ### Request Example { "user": { "email": "string", "first_name": "string", "last_name": "string", "role": "user", "community_ids": [0], "all_communities": true } } ### Response #### Success Response (201) - **user** (object) - The created user object. #### Response Example { "id": 0, "email": "string", "first_name": "string", "last_name": "string", "role": "user", "community_ids": [0], "all_communities": true, "created_at": "2000-01-01T12:00:00.000Z", "deactivated_at": null, "updated_at": "2000-01-01T12:00:00.000Z" } ``` -------------------------------- ### GET /scores Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieves a list of all scores available in the system. ```APIDOC ## GET /scores ### Description List all scores. ### Method GET ### Endpoint /scores ### Response #### Success Response (200) - **id** (integer) - Score ID - **name** (string) - Score name - **position** (integer) - Display position - **for_referrers** (boolean) - Applicable to referrers - **for_prospects** (boolean) - Applicable to prospects - **created_at** (string) - Creation timestamp - **updated_at** (string) - Last update timestamp #### Response Example [ { "id": 0, "name": "string", "position": 0, "for_referrers": true, "for_prospects": true, "created_at": "string", "updated_at": "string" } ] ``` -------------------------------- ### POST /users Source: https://crm.welcomehomesoftware.com/api-docs/v1/swagger.yaml Creates a new user in the system. Requires an API Token with access to all communities. ```APIDOC ## POST /users ### Description Creates a new user. Requires an API Token with access to all communities. ### Method POST ### Endpoint /users ### Request Body - **user** (object) - Required - **email** (string) - Optional - **first_name** (string) - Optional - **last_name** (string) - Optional - **role** (string) - Optional - Enum: user, admin, regional, notification_only, user_manager, read_only - **community_ids** (array) - Optional - Communities this user has access to. Not needed for admin role users. - **all_communities** (boolean) - Optional - Set to true if user should have access to all communities. If setting individual community_ids and all_communities is not provided, it will automatically be set to false. If setting community_ids to an empty array and all_communities is not provided, it will automatically be set to true. ### Response #### Success Response (201) - **id** (integer) - **email** (string) - **first_name** (string) - **last_name** (string) - **role** (string) - **community_ids** (array) - **all_communities** (boolean) - **created_at** (datetime) - **deactivated_at** (datetime) - **updated_at** (datetime) #### Error Response (422) - **errors** (object) - Contains validation errors (e.g., user.email: ["can't be blank"]) ``` -------------------------------- ### GET /residents/{id} Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieves details for a specific resident. ```APIDOC ## GET /residents/{id} ### Description Retrieves details for a specific resident. ### Method GET ### Endpoint /residents/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the resident. ``` -------------------------------- ### GET /prospect_fields Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieves a list of all defined prospect fields. ```APIDOC ## GET /prospect_fields ### Description Lists all prospect fields defined in the system. ### Method GET ### Endpoint /prospect_fields ### Response #### Success Response (200) - **id** (integer) - Field ID - **name** (string) - Field name #### Response Example [ { "id": 0, "name": "string" } ] ``` -------------------------------- ### Request Sample for Create Event Source: https://crm.welcomehomesoftware.com/api-docs/index.html This JSON object is a sample payload for creating an event. It requires details such as community ID, name, date, time, location, and budget. ```json { "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 } } ``` -------------------------------- ### GET /events Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieves a list of events with optional filtering. ```APIDOC ## GET /events ### Description Retrieves a list of events with optional filtering. ### Method GET ### Endpoint /events ### Parameters #### Query Parameters - **limit** (integer) - Optional - Numbers of records to return per page (Default: 10, Max: 100) - **filters[community_id]** (integer) - Optional - Filter by community ID - **filters[created_at_after]** (string) - Optional - Filter by creation date after - **filters[created_at_before]** (string) - Optional - Filter by creation date before - **filters[updated_at_after]** (string) - Optional - Filter by update date after - **filters[updated_at_before]** (string) - Optional - Filter by update date before ### Response #### Success Response (200) - **id** (integer) - Event ID - **community_id** (integer) - Community ID - **name** (string) - Event name #### Response Example [ { "id": 0, "community_id": 0, "name": "string" } ] ``` -------------------------------- ### List Prospect Activities Source: https://crm.welcomehomesoftware.com/api-docs/v1/swagger.yaml Retrieves a list of all prospect activities. ```APIDOC ## GET /activities ### Description Retrieves a list of all prospect activities. ### Method GET ### Endpoint /activities ### Parameters #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **id** (integer) - Unique identifier for the activity. - **completed_at** (datetime) - The timestamp when the activity was completed. - **direction** (string) - The direction of the activity (e.g., inbound, outbound). - **notes** (string) - Any notes associated with the activity. - **sales_counselor_id** (integer) - The ID of the sales counselor associated with the activity. - **scheduled_at** (datetime) - The timestamp when the activity is scheduled. - **created_at** (string) - The timestamp when the activity was created. - **updated_at** (string) - The timestamp when the activity was last updated. - **record_type** (string) - The type of record the activity is associated with. - **record_id** (integer) - The ID of the record the activity is associated with. - **stage_id** (integer) - The ID of the stage the activity belongs to. - **activity_type_id** (integer) - The ID of the activity type. - **discarded_at** (datetime) - The timestamp when the activity was discarded. - **activity_result_id** (integer) - The ID of the activity result. - **pinned** (boolean) - Indicates if the activity is pinned. - **community_id** (integer) - The ID of the community associated with the activity. - **created_by_id** (integer) - The ID of the user who created the activity. - **completed_successfully** (boolean) - Indicates if the activity was completed successfully. - **add_to_calendar** (boolean) - Indicates if the activity should be added to the calendar. - **time_zone** (string) - The time zone for calendar events. Example: "Eastern Time (US & Canada)". - **calendar_event_start_time** (string) - The start time for calendar events. Example: "14:00". - **calendar_event_end_time** (string) - The end time for calendar events. Example: "15:00". - **person_ids** (array of integers) - A list of IDs of people associated with the activity. #### Response Example ```json [ { "id": 1, "completed_at": "2023-10-27T10:00:00Z", "direction": "outbound", "notes": "Follow up call", "sales_counselor_id": 101, "scheduled_at": "2023-10-27T11:00:00Z", "created_at": "2023-10-26T09:00:00Z", "updated_at": "2023-10-26T09:00:00Z", "record_type": "lead", "record_id": 201, "stage_id": 1, "activity_type_id": 2, "discarded_at": null, "activity_result_id": 3, "pinned": false, "community_id": 5, "created_by_id": 101, "completed_successfully": true, "add_to_calendar": false, "time_zone": "Eastern Time (US & Canada)", "calendar_event_start_time": "14:00", "calendar_event_end_time": "15:00", "person_ids": [301, 302] } ] ``` ``` -------------------------------- ### GET /care_types Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieves a list of all available care types. ```APIDOC ## GET /care_types ### Description Retrieves a list of all available care types. ### Method GET ### Endpoint /care_types ### Response #### Success Response (200) - **id** (integer) - Unique identifier - **name** (string) - Name of the care type - **abbreviation** (string) - Abbreviation of the care type - **created_at** (string) - Creation timestamp - **updated_at** (string) - Last update timestamp #### Response Example [ { "id": 0, "name": "Assisted Living", "abbreviation": "AL", "created_at": "string", "updated_at": "string" } ] ``` -------------------------------- ### GET /activity_types Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieves a list of all available activity types. ```APIDOC ## GET /activity_types ### Description Retrieves a list of all available activity types. ### Method GET ### Endpoint /activity_types ### Response #### Success Response (200) - **id** (integer) - Unique identifier - **account_id** (integer) - Account identifier - **name** (string) - Name of the activity type - **created_at** (string) - Creation timestamp - **updated_at** (string) - Last update timestamp #### Response Example [ { "id": 0, "account_id": 0, "name": "Tour", "created_at": "string", "updated_at": "string" } ] ``` -------------------------------- ### Response Sample for List Activity Types Source: https://crm.welcomehomesoftware.com/api-docs/index.html This JSON array represents a sample response when listing activity types. Each object contains an ID, account ID, name, and timestamps. ```json [ { "id": 0, "account_id": 0, "name": "Tour", "created_at": "string", "updated_at": "string" } ] ``` -------------------------------- ### GET /user_roles Source: https://crm.welcomehomesoftware.com/api-docs/v1/swagger.yaml Retrieves a list of user roles available in the system. ```APIDOC ## GET /user_roles ### Description Returns a list of user roles. ### Method GET ### Endpoint /user_roles ### Parameters #### Query Parameters - **filters[community_id]** (integer) - Optional - Filter roles by community ID ``` -------------------------------- ### GET /prospect_fields Source: https://crm.welcomehomesoftware.com/api-docs/v1/swagger.yaml Retrieves a list of custom fields defined for prospects. ```APIDOC ## GET /prospect_fields ### Description List all custom prospect fields available for data entry. ### Method GET ### Endpoint /prospect_fields ### Response #### Success Response (200) - **id** (integer) - Unique identifier - **name** (string) - Field name - **field_type** (string) - Type of field (amount, date, checkbox, single_line_text, paragraph) - **created_at** (string) - Creation timestamp - **updated_at** (string) - Last update timestamp #### Response Example [ { "id": 1, "name": "Budget", "field_type": "amount", "created_at": "2023-01-01T00:00:00Z", "updated_at": "2023-01-01T00:00:00Z" } ] ``` -------------------------------- ### User Response Sample Source: https://crm.welcomehomesoftware.com/api-docs/index.html This JSON represents a successful response when retrieving or updating user information. It includes user details, roles, community associations, and timestamps. ```json { "id": 0, "email": "string", "first_name": "string", "last_name": "string", "role": "user", "community_ids": [ 0 ], "all_communities": true, "created_at": "2000-01-01T12:00:00.000Z", "deactivated_at": null, "updated_at": "2000-01-01T12:00:00.000Z" } ``` -------------------------------- ### Response Sample for List Events Source: https://crm.welcomehomesoftware.com/api-docs/index.html This JSON array represents a sample response when listing events. Each event object includes details like ID, community ID, name, date, time, location, and cost information. ```json [ { "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": null, "updated_at": null } ] ``` -------------------------------- ### GET /units/{id} Source: https://crm.welcomehomesoftware.com/api-docs/index.html Retrieves details for a specific unit by its ID. ```APIDOC ## GET /units/{id} ### Description Retrieves the details of a specific unit. ### Method GET ### Endpoint /units/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the unit. #### Query Parameters - **include_market_rate_for_date** (date) - Optional - Example: "today" ### Response #### Success Response (200) - **id** (integer) - **number** (string) - **amenities** (array) - **care_type_id** (integer) - **community_id** (integer) - **floor_plan_id** (string) - **occupancy_point_factor** (number) - **off_census** (boolean) - **market_rate** (number) - **second_resident_market_rate** (number) #### Response Example { "id": 0, "number": "string", "amenities": ["string"], "care_type_id": 0, "community_id": 0, "floor_plan_id": "string", "occupancy_point_factor": 1, "off_census": true, "market_rate": 0, "second_resident_market_rate": 0 } ```