Table of Contents
A Person is an individual who has applied for services through a referral form. A single Person document can be associated with many different referrals in Supportable.
Sample Request #
Headers | Authorization = Bearer [token] |
Parameters | None |
Body | None |
Get all Persons for Company #
GET https://connect.supportableapp.com/api/persons
Get individual Person #
GET https://connect.supportableapp.com/api/persons/{personId}
Sample Response JSON #
Status: 200
[ { "id": "63a359da9f76a83b448d5480", "firstName": "Angela", "middleName": "", "lastName": "Anderson", "preferredName": "", "dob": "1998-12-10T00:00:00.000Z", "ssn": "123456789", "address": { "address1": "", "address2": null, "city": "Minneapolis", "state": { "_id": "MN", "name": "Minnesota" }, "zip": "55408", "county": { "id": "622b13455378a35df240ecd9", "status": true, "name": "Hennepin" } }, "sex": { "id": "6229d252dde96cb71bd9aa3e", "status": true, "name": "Female" }, "genders": [ { "id": "6229d21cdde96cb71bd99b39", "status": true, "name": "Female" } ], "races": [ { "id": "6229d229dde96cb71bd99b45", "status": true, "name": "Asian" } ], "ethnicities": [ { "id": "6229d20adde96cb71bd99b33", "status": true, "name": "Cuban" }, { "id": "6229d20adde96cb71bd99b31", "status": true, "name": "Puerto Rican" } ], "homePhoneNumber": "1234567890", "mobileNumber": "0987654321", "email": "angelaanderson@hotmail.com", "hasGuardian": false, "needTranslator": false, "language": null, "countyOfFinancialResponsibility": "Hennepin" } ]
Notes on Values #
Attribute | Data Type | Description |
---|---|---|
id | string | The unique identifier for the Intake User. |
firstName | string | The first name of the Person. |
middleName | string | The middle name of the Person. |
lastName | string | The last name of the Person. |
preferredName | string | The name by which the Person prefers to be addressed, if different from their legal name. |
dob | datetime | The ISO date value of the Person’s date of birth. |
ssn | string | The extension of the Intake User’s business phone number, if any. |
address | object | The primary address for the Person. |
address.address1 | string | The first line of the Person’s address. |
address.address2 | string | The second line of the Person’s address. |
address.city | string | The city component of the Person’s address. |
address.state | object | The state component of the Person’s address. |
address.state.id | string | The 2-letter state code. |
address.state.name | string | The full name of the state. |
address.zip | string | The ZIP code component of the Person’s address. |
address.county | string | The county component of the Person’s address. |
sex | object | The sex with which the Person identifies (note: A Person may only have a single sex in Supportable). |
sex.id | string | The unique identifier for the sex. |
sex.name | string | The name of the sex. |
sex.status | string | Whether the sex is active in Supportable. |
genders | array of objects | The gender(s) with which the Person identifies. |
genders.id | string | The unique identifier for the gender. |
genders.name | string | The name of the gender. |
genders.status | string | Whether the gender is active in Supportable. |
races | array of objects | The race(s) with which the Person identifies. |
races.id | string | The unique identifier for the race. |
races.name | string | The name of the race. |
races.status | string | Whether the race is active in Supportable. |
ethnicities | array of objects | The ethnicity with which the Person identifies. |
ethnicities.id | string | The unique identifier for the ethnicity. |
ethnicities.name | string | The name of the ethnicity. |
ethnicities.status | string | Whether the ethnicity is active in Supportable. |
homePhoneNumber | string | The home phone number for the Person. |
mobilePhoneNumber | string | The mobile phone number for the Person. |
string | The primary email address for the Person. | |
hasGuardian | boolean | Whether the Person is under guardianship/conservatorship. |
needTranslator | boolean | Whether the Person requires a translator to communicate. |
language | string | The language the Person speaks, if they require a translator. |
countyOfFinancialResponsibility | string | The unique identifier of the county which handles the financial responsibility for the Person. |