Table of Contents
In Supportable, a Location refers to a physical building or community within the organization. Offices, apartments, and houses managed by the organization are all considered Locations. A Location can have multiple associations with different Offerings, meaning those Offerings can be administered at the Location and Persons with referrals for those Offerings can be placed at the Location.
Sample Request #
| Headers | Authorization = Bearer [token] |
| Parameters | None |
| Body | None |
GET https://connect.supportableapp.com/api/locations
Sample Response JSON #
Status: 200
[
{
"_id": "6356c850fd581c6a5c8f2e64",
"status": true,
"name": "Swallow Valley",
"address": "19029 Apple Way, Macintosh, MN 55555",
"locationTypeId": "62860d0cf31490171ab7b9df",
"locationAssociations": [
{
"subEntityId": "631b78b3b85f7b84cd478b28",
"offeringId": "6311a1dac42741794219e7bd"
},
{
"subEntityId": "6346eca89f32eacd40ee875c",
"offeringId": "6342e722ef17a9371572500b"
},
{
"subEntityId": "6346eca89f32eacd40ee875c",
"offeringId": "63456bb39f32eacd40ee8667"
},
{
"subEntityId": "6346eca89f32eacd40ee875c",
"offeringId": "63456fd59f32eacd40ee8673"
},
{
"subEntityId": "6346eca89f32eacd40ee875c",
"offeringId": "63457ab49f32eacd40ee8685"
},
{
"subEntityId": "6346eca89f32eacd40ee875c",
"offeringId": "6345785d9f32eacd40ee867f"
}
]
},
. . .
]
Notes on Values #
| Attribute | Data Type | Description |
|---|---|---|
| id | string | The unique identifier for the Location. |
| status | boolean | Whether the Location is active in Supportable. |
| name | string | The name of the Location given by the organization. |
| address | string | The address for the Location. |
| locationTypeId | string | The unique identifier for the Location Type with which the Location is associated. |
| locationAssociations | array of objects | The Offerings with which this Location is associated, as well as their associated Sub-Entities. |
| locationAssociations.offeringId | string | The unique identifier of the Offering. |
| locationAssociations.subEntityId | string | The unique identifier of the Sub-Entity with which the Offering is associated. |
