Contact

Table of Contents

Sample Request
Sample Response JSON
Notes on Values

Contacts are persons outside of the organization with whom the intake team must communicate and coordinate. Contacts are associated with Persons. At this time, Contacts are not shared between Persons.

Sample Request #

Headers	Authorization = Bearer [token]
Parameters	None
Body	None

GET https://connect.supportableapp.com/api/persons/{personId}/contacts

Sample Response JSON #

Status: 200

[
  {
    "id": "63994900375b94cfdaedad3b",
    "status": true,
    "name": "Lina Liamson",
    "personId": "63994727375b94cfdaedad34",
    "phone": "7777777777",
    "phone2": null,
    "phone3": null,
    "email": null,
    "email2": null,
    "address": null,
    "fax": null,
    "fax2": null,
    "organization": null,
    "organizationOther": null,
    "relationship": {
      "id": "62fdfa10e34d63f231759082",
      "name": "Other family/relative"
    },
    "relationshipOther": null,
    "isEmergency": true,
    "isGuardian": false,
  },
  . . .
]

Notes on Values #

Attribute	Data Type	Description
id	string	The unique identifier of the Contact.
status	boolean	Whether the Contact is active in Supportable. If false, the Contact has been removed from the Person’s Contact list in the applicationt.
name	string	The name of the Contact.
personId	string	The unique identifier of the Person with whom the Contact is associated.
phone	string	The primary phone number of the Contact.
phone2	string	The secondary phone number of the Contact.
phone3	string	The tertiary phone number of the Contact.
email	string	The primary email of the Contact.
email2	string	The secondary email of the Contact.
address	string	The address of the Contact.
fax	string	The primary fax of the Contact.
fax2	string	The secondary fax of the Contact.
organization	object	The organization, if any, to which the Contact belongs.
organization.id	string	The unique identifier of the organization.
organization.name	string	The name of the organization.
organization.status	boolean	Whether the organization is active in Supportable.
organizationOther	string	The name of the organization, if not included in Supportable’s list of organizations.
relationship	object	The relationship of the Contact to the Person.
relationship.id	string	The unique identifier of the relationship.
relationship.name	string	The name of the relationship.
relationship.status	boolean	Whether the relationship is active in Supportable.
relationshipOther	string	The name of the relationship, if not included in Supportable’s list of organizations.
isEmergency	boolean	Whether the Contact holds emergency contact status on the Person’s Contact list.
isGuardian	boolean	Whether the Contact holds guardian status on the Person’s Contact list.