Table of Contents
Supportable maintains a global list of Relationships which denote relationships between a Person and a Contact, Payer, Referent, etc.
Sample Request #
Headers | Authorization = Bearer [token] |
Parameters | None |
Body | None |
GET https://connect.supportableapp.com/api/relationships
Sample Response JSON #
Status: 200
[ { "id": "62fdfa10e34d63f231759074", "name": "Counselor/therapist", "professional": true, "guardian": false, "payer": false, "status": true }, { "id": "62fdfa10e34d63f231759085", "name": "Probation officer", "professional": true, "guardian": false, "payer": false, "status": true }, { "id": "62fdfa10e34d63f231759089", "name": "Service provider", "professional": true, "guardian": false, "payer": false, "status": true }, { "id": "62fdfa10e34d63f23175908a", "name": "Sibling", "professional": false, "guardian": true, "payer": false, "status": true }, . . . ]
Notes on Values #
Attribute | Data Type | Description |
---|---|---|
id | string | The unique identifier of the Relationship. |
name | string | The name of the Relationship as it appears in the application. |
professional | boolean | Whether the Relationship is a professional type. |
guardian | boolean | Whether the Relationship can be applied to a guardian. |
payer | boolean | Whether the Relationship can be applied to a payer. |
status | boolean | Whether the Relationship is active in Supportable. |