Bickford Senior Living VIA API (1.0.2)

Download OpenAPI specification:Download

Introduction

This documentation covers the VIA platform API.

OpenAPI Specification

This API is documented in OpenAPI format, which can be found here.

Endpoint Definition

VIA provides three environment endpoints to support your development project:

production: https://orchestrator.via.bickfordcloud.com/api/v1/via
stage: https://orchestrator.stage.nonprod.via.bickfordcloud.com/api/v1/via
dev: https://orchestrator.dev.nonprod.via.bickfordcloud.com/api/v1/via

Authentication

VIA currently offers HTTP basic auth for authentication. The format is standard: username:apiKey, and must be base64-encoded. So for a username of user and an API key of 34c48c4c219c9be8b569c0cd63, the value to pass in the Authorization header would be: Authorization: Basic dXNlcjozNGM0OGM0YzIxOWM5YmU4YjU2OWMwY2Q2Mw==

Basic Auth

Security Scheme Type: HTTP

HTTP Authorization Scheme: basic

Sub-Accounts

List Sub-Accounts

Return list of sub-accounts. In most cases a sub-account will map to a community or property.

Authorizations:

Basic Auth

Request Body schema: application/json

Array

id	string <UUID>
name	string

Request samples

Payload

Content type

application/json

[{"id": "88aaa4f3-ada9-464f-88c5-32ee934ba964",
"name": "Sunrise Senior Living of Coopersfield"
}
]

eLeads

List eLeads

Authorizations:

Basic Auth

query Parameters

limit	integer <int32> How many items to return at one time (max 250)
offset	integer <int32> Combined with the limit, how many items to skip from the beginning
processed	boolean Return only processed or unprocessed eLeads
duplicate	integer Return only duplicate or not duplicate eLeads

Responses

Response samples

200

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"id": "6e061ea5-bd16-48ea-8554-7c3bdfb2f75e",
"sub_account_id": "d8763dab-bcca-4aae-bd2b-0b953ecb64e7",
"prospect_first_name": "Sarah",
"prospect_last_name": "Smith",
"prospect_email": "sarah.smith@example.com",
"prospect_phone_number": "+15555984125",
"primary_contact_first_name": "Phil",
"primary_contact_last_name": "Smith",
"primary_contact_email": "phil.smith@example.com",
"primary_contact_phone_number": "+15559722145",
"lead_source_type_id": 2,
"relationship_id": 5,
"notes": "Lorem ipsum foo bar baz",
"lead_id": null,
"is_duplicate": false,
"processed": false
}

Get eLead

Authorizations:

Basic Auth

path Parameters

sub_account_id required	string The ID of the subAccount that relates to the eLead to retrieve
e_lead_id required	string The ID of the eLead to retrieve. This can be either the internal id or the external id provided when the eLead was created.

Responses

Response samples

200

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"id": "6e061ea5-bd16-48ea-8554-7c3bdfb2f75e",
"sub_account_id": "d8763dab-bcca-4aae-bd2b-0b953ecb64e7",
"prospect_first_name": "Sarah",
"prospect_last_name": "Smith",
"prospect_email": "sarah.smith@example.com",
"prospect_phone_number": "+15555984125",
"primary_contact_first_name": "Phil",
"primary_contact_last_name": "Smith",
"primary_contact_email": "phil.smith@example.com",
"primary_contact_phone_number": "+15559722145",
"lead_source_type_id": 2,
"relationship_id": 5,
"notes": "Lorem ipsum foo bar baz",
"lead_id": null,
"is_duplicate": false,
"processed": false
}

Create eLead

Either the lead_source_type_id or lead_source_type_code must be specified. Please see the lead statuses and relationship endpoints for possible values.

Authorizations:

Basic Auth

path Parameters

sub_account_id

required

string

The ID of the subAccount that relates to the eLead being created

Request Body schema: application/json

Any of

prospect_first_name	string
prospect_last_name	string
prospect_email	string
prospect_phone_number	string <E.164>
primary_contact_first_name	string
primary_contact_last_name	string
primary_contact_email	string
primary_contact_phone_number	string <E.164>
lead_source_type_id required	int32
lead_source_type_code	string
relationship_id	int32
relationship_code	string
notes	string
external_id	string Unique identifier for the activity in the external system

Responses

Request samples

Payload

Content type

application/json

{"prospect_first_name": "string",
"prospect_last_name": "string",
"prospect_email": "string",
"prospect_phone_number": "+15552056030",
"primary_contact_first_name": "string",
"primary_contact_last_name": "string",
"primary_contact_email": "string",
"primary_contact_phone_number": "+15552056030",
"lead_source_type_id": 8,
"lead_source_type_code": "direct_mail",
"relationship_id": 9,
"relationship_code": "niece",
"notes": "Lorem ipsum foo bar baz",
"external_id": 555
}

Response samples

200

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"id": "6e061ea5-bd16-48ea-8554-7c3bdfb2f75e",
"sub_account_id": "d8763dab-bcca-4aae-bd2b-0b953ecb64e7",
"prospect_first_name": "Sarah",
"prospect_last_name": "Smith",
"prospect_email": "sarah.smith@example.com",
"prospect_phone_number": "+15555984125",
"primary_contact_first_name": "Phil",
"primary_contact_last_name": "Smith",
"primary_contact_email": "phil.smith@example.com",
"primary_contact_phone_number": "+15559722145",
"lead_source_type_id": 2,
"relationship_id": 5,
"notes": "Lorem ipsum foo bar baz",
"lead_id": null,
"is_duplicate": false,
"processed": false
}

Update eLead

Either the lead_source_type_id or lead_source_type_code must be specified. Please see the lead statuses and relationship endpoints for possible values.

Authorizations:

Basic Auth

path Parameters

sub_account_id required	string The ID of the subAccount that relates to the eLead being updated
e_lead_id required	string The ID of the eLead to update. This can be either the internal id or the external id provided when the eLead was created.

Request Body schema: application/json

Any of

prospect_first_name	string
prospect_last_name	string
prospect_email	string
prospect_phone_number	string <E.164>
primary_contact_first_name	string
primary_contact_last_name	string
primary_contact_email	string
primary_contact_phone_number	string <E.164>
lead_source_type_id required	int32
lead_source_type_code	string
relationship_id	int32
relationship_code	string
notes	string
external_id	string Unique identifier for the activity in the external system

Responses

Request samples

Payload

Content type

application/json

{"prospect_first_name": "string",
"prospect_last_name": "string",
"prospect_email": "string",
"prospect_phone_number": "+15552056030",
"primary_contact_first_name": "string",
"primary_contact_last_name": "string",
"primary_contact_email": "string",
"primary_contact_phone_number": "+15552056030",
"lead_source_type_id": 8,
"lead_source_type_code": "direct_mail",
"relationship_id": 9,
"relationship_code": "niece",
"notes": "Lorem ipsum foo bar baz",
"external_id": 555
}

Response samples

200

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"id": "6e061ea5-bd16-48ea-8554-7c3bdfb2f75e",
"sub_account_id": "d8763dab-bcca-4aae-bd2b-0b953ecb64e7",
"prospect_first_name": "Sarah",
"prospect_last_name": "Smith",
"prospect_email": "sarah.smith@example.com",
"prospect_phone_number": "+15555984125",
"primary_contact_first_name": "Phil",
"primary_contact_last_name": "Smith",
"primary_contact_email": "phil.smith@example.com",
"primary_contact_phone_number": "+15559722145",
"lead_source_type_id": 2,
"relationship_id": 5,
"notes": "Lorem ipsum foo bar baz",
"lead_id": null,
"is_duplicate": false,
"processed": false
}

Leads

List Leads

Authorizations:

Basic Auth

query Parameters

limit	integer <int32> How many items to return at one time (max 250)
offset	integer <int32> Combined with the limit, how many items to skip from the beginning

Responses

Response samples

200

Content type

application/json

{"count": 651,
"sub_account_leads": [{"id": "c5f3cbf7-4227-4622-b4a6-e09709f53763",
"created_at": "2019-08-24T14:15:22Z",
"lead": {"id": "fab336e0-fb79-44ad-bafe-b3f76b98fc18",
"person_id": "8e070496-50f8-4d88-b7fd-1f0e938c65f5",
"person": {"id": "8e070496-50f8-4d88-b7fd-1f0e938c65f5",
"first_name": "string",
"preferred_name": "string",
"last_name": "string",
"email": "string",
"is_subscribed": "false, null",
"primary_contact_id": "8e070496-50f8-4d88-b7fd-1f0e938c65f5",
"phones": [{"id": "7598a4f3-ada9-464f-88c5-32ee934ba964",
"number": "+15552056030",
"phone_type_id": 3,
"is_opted_out": "false, null",
"phone_type": {"id": 3,
"code": "mobile",
"name": "Mobile"
}
}
],
"contacts": [{"id": "71dce304-6790-47b7-ad72-af8c9622f6c1",
"first_name": "string",
"preferred_name": "string",
"last_name": "string",
"email": "string",
"is_subscribed": "false, null",
"phones": [{"id": "7598a4f3-ada9-464f-88c5-32ee934ba964",
"number": "+15552056030",
"phone_type_id": 3,
"is_opted_out": "false, null",
"phone_type": {"id": null,
"code": null,
"name": null
}
}
],
"related_person": {"id": "4de6c050-16ea-49d8-857f-0fb5cf1f7ebd",
"person_id": "8e070496-50f8-4d88-b7fd-1f0e938c65f5",
"related_id": "4a9f48b7-51a3-4976-b18c-57159bc77471",
"notes": "Lorem ipsum foo bar baz",
"relationship_id": 2
}
}
]
},
"lead_sources": [{"lead_source_type_id": 15,
"lead_source_type": {"id": 15,
"code": "string",
"name": "string"
}
}
]
},
"stage": {"id": 3,
"code": "tour.scheduled",
"name": "Tour Scheduled"
},
"status": {"id": 5,
"code": "warm",
"name": "Warm"
},
"sub_account": {"id": "7598a4f3-ada9-464f-88c5-32ee934ba964",
"name": "Sunrise Senior Living of Coopersfield"
}
}
]
}

Get Lead

Authorizations:

Basic Auth

path Parameters

sub_account_id required	string The ID of the subAccount that relates to the lead to retrieve
lead_id required	string The ID of the lead to retrieve

Responses

Response samples

200

Content type

application/json

{"id": "c5f3cbf7-4227-4622-b4a6-e09709f53763",
"created_at": "2019-08-24T14:15:22Z",
"lead": {"id": "fab336e0-fb79-44ad-bafe-b3f76b98fc18",
"person_id": "8e070496-50f8-4d88-b7fd-1f0e938c65f5",
"person": {"id": "8e070496-50f8-4d88-b7fd-1f0e938c65f5",
"first_name": "string",
"preferred_name": "string",
"last_name": "string",
"email": "string",
"is_subscribed": "false, null",
"primary_contact_id": "8e070496-50f8-4d88-b7fd-1f0e938c65f5",
"phones": [{"id": "7598a4f3-ada9-464f-88c5-32ee934ba964",
"number": "+15552056030",
"phone_type_id": 3,
"is_opted_out": "false, null",
"phone_type": {"id": 3,
"code": "mobile",
"name": "Mobile"
}
}
],
"contacts": [{"id": "71dce304-6790-47b7-ad72-af8c9622f6c1",
"first_name": "string",
"preferred_name": "string",
"last_name": "string",
"email": "string",
"is_subscribed": "false, null",
"phones": [{"id": "7598a4f3-ada9-464f-88c5-32ee934ba964",
"number": "+15552056030",
"phone_type_id": 3,
"is_opted_out": "false, null",
"phone_type": {"id": 3,
"code": "mobile",
"name": "Mobile"
}
}
],
"related_person": {"id": "4de6c050-16ea-49d8-857f-0fb5cf1f7ebd",
"person_id": "8e070496-50f8-4d88-b7fd-1f0e938c65f5",
"related_id": "4a9f48b7-51a3-4976-b18c-57159bc77471",
"notes": "Lorem ipsum foo bar baz",
"relationship_id": 2
}
}
]
},
"lead_sources": [{"lead_source_type_id": 15,
"lead_source_type": {"id": 15,
"code": "string",
"name": "string"
}
}
]
},
"stage": {"id": 3,
"code": "tour.scheduled",
"name": "Tour Scheduled"
},
"status": {"id": 5,
"code": "warm",
"name": "Warm"
},
"sub_account": {"id": "7598a4f3-ada9-464f-88c5-32ee934ba964",
"name": "Sunrise Senior Living of Coopersfield"
}
}

Lead Activities

List Lead Activities

Authorizations:

Basic Auth

path Parameters

lead_id

required

string

The ID of the lead to retrieve activities for

Responses

Response samples

200

Content type

application/json

[{"id": "fcbbcb7c-d29f-4de9-8575-aea89a97ef24",
"created_at": "2019-08-24T14:15:22Z",
"lead_id": "fcbbcb7c-d29f-4de9-8575-aea89a97ef24",
"sub_account_id": "fcbbcb7c-d29f-4de9-8575-aea89a97ef24",
"scheduled_date": "2019-08-24T14:15:22Z",
"completed": true,
"completed_date": "2019-08-24T14:15:22Z",
"activity_type_id": 20,
"activity_result_id": 26,
"notes": "Lorem ipsum foo bar baz"
}
]

Create Lead Activity

Either the activity_type_id or activity_type_code must be specified. If you wish to specify a result, either the activity_result_id or activity_result_code can be specified. Please see the activity type and result end points to see possible values. If a result is specified it must be valid for the activity type.

Authorizations:

Basic Auth

path Parameters

sub_account_id required	string The ID of the subAccount that relates to the lead the activity will be created for
lead_id required	string The ID of the lead to create an activity for

Request Body schema: application/json

Any of

activity_type_id required	int32 Either `activity_type_id` or `activity_type_code` must be provided
activity_type_code	string Either `activity_type_id` or `activity_type_code` must be provided
notes	string
scheduled_date	string <date-time>
updated_at	string <date-time>
completed	boolean
completed_date	string <date-time>
activity_result_id	int32
activity_result_code	string
external_id	string Unique identifier for the activity in the external system

Responses

Request samples

Payload

Content type

application/json

{"activity_type_id": 5,
"activity_type_code": "call.outbound",
"notes": "Lorem ipsum foo bar baz",
"scheduled_date": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"completed": true,
"completed_date": "2019-08-24T14:15:22Z",
"activity_result_id": 1,
"activity_result_code": "outbound.success",
"external_id": 555
}

Response samples

200

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"id": "fcbbcb7c-d29f-4de9-8575-aea89a97ef24",
"lead_id": "fcbbcb7c-d29f-4de9-8575-aea89a97ef24",
"sub_account_id": "fcbbcb7c-d29f-4de9-8575-aea89a97ef24",
"scheduled_date": "2019-08-24T14:15:22Z",
"completed": true,
"completed_date": "2019-08-24T14:15:22Z",
"activity_type_id": 20,
"activity_result_id": 26,
"notes": "Lorem ipsum foo bar baz"
}

Update Lead Activity

Either the activity_type_id or activity_type_code must be specified. If you wish to specify a result, either the activity_result_id or activity_result_code can be specified. Please see the activity type and result end points to see possible values. If a result is specified it must be valid for the activity type.

Authorizations:

Basic Auth

path Parameters

sub_account_id required	string The ID of the subAccount that relates to the lead the activity was created for
activity_id required	string The ID of the activity to update. This can be either the internal id or the external id provided when the activity was created.

Request Body schema: application/json

Any of

activity_type_id required	int32 Either `activity_type_id` or `activity_type_code` must be provided
activity_type_code	string Either `activity_type_id` or `activity_type_code` must be provided
notes	string
scheduled_date	string <date-time>
updated_at	string <date-time>
completed	boolean
completed_date	string <date-time>
activity_result_id	int32
activity_result_code	string
external_id	string Unique identifier for the activity in the external system

Responses

Request samples

Payload

Content type

application/json

{"activity_type_id": 5,
"activity_type_code": "call.outbound",
"notes": "Lorem ipsum foo bar baz",
"scheduled_date": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"completed": true,
"completed_date": "2019-08-24T14:15:22Z",
"activity_result_id": 1,
"activity_result_code": "outbound.success",
"external_id": 555
}

Response samples

200

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"id": "fcbbcb7c-d29f-4de9-8575-aea89a97ef24",
"lead_id": "fcbbcb7c-d29f-4de9-8575-aea89a97ef24",
"sub_account_id": "fcbbcb7c-d29f-4de9-8575-aea89a97ef24",
"scheduled_date": "2019-08-24T14:15:22Z",
"completed": true,
"completed_date": "2019-08-24T14:15:22Z",
"activity_type_id": 20,
"activity_result_id": 26,
"notes": "Lorem ipsum foo bar baz"
}

References

Activity Types

Authorizations:

Basic Auth

query Parameters

scope

string

Enum: "lead" "referral_source" "resident"

Example: scope=referrer

Filter the step of activity types by their "entity scope". Defaults to lead

Request Body schema: application/json

Array

id	int32
code	string
name	string
	Array of objects (ActivityResult) List of valid results

Request samples

Payload

Content type

application/json

[{"id": 9,
"code": "call.outbound",
"name": "Call - Outbond",
"results": [{"id": 5,
"code": "outbound.success",
"name": "Outbound - Success"
}
]
}
]

Care Types

Authorizations:

Basic Auth

Request Body schema: application/json

Array

id	int32
code	string
name	string

Request samples

Payload

Content type

application/json

[{"id": 5,
"code": "string",
"name": "string"
}
]

Lead Source Types

List source types for leads. Examples would be: "billboards", "A Place for Mom", "Local Business".

Authorizations:

Basic Auth

Request Body schema: application/json

Array

id	int32
code	string
name	string

Request samples

Payload

Content type

application/json

[{"id": 5,
"code": "string",
"name": "string"
}
]

Relationships

List relationships. Examples: "spouse", "son", "trust_officer".

Authorizations:

Basic Auth

Request Body schema: application/json

Array

id	int32
code	string
name	string

Request samples

Payload

Content type

application/json

[{"id": 5,
"code": "string",
"name": "string"
}
]

Phone Types

List relationships. Examples: "home", "mobile".

Authorizations:

Basic Auth

Request Body schema: application/json

Array

id	int32
code	string
name	string

Request samples

Payload

Content type

application/json

[{"id": 5,
"code": "string",
"name": "string"
}
]

Lead Statuses

List available lead statuses for the account. Examples: "hot", "warm".

Authorizations:

Basic Auth

Request Body schema: application/json

Array

id	int32
code	string
name	string

Request samples

Payload

Content type

application/json

[{"id": 5,
"code": "string",
"name": "string"
}
]

Lead Stages

List available lead stages for the account. Examples: "contacted", "tour.scheduled", "deposit.made"

Authorizations:

Basic Auth

Request Body schema: application/json

Array

id	int32
code	string
name	string

Request samples

Payload

Content type

application/json

[{"id": 5,
"code": "string",
"name": "string"
}
]

Reasons

List reasons. Examples: "Financial", "Level of Care".

Authorizations:

Basic Auth

Request Body schema: application/json

Array

id	int32
code	string
name	string

Request samples

Payload

Content type

application/json

[{"id": 5,
"code": "string",
"name": "string"
}
]