Intake Stage

Table of Contents

Sample Request
Sample Response JSON
Notes on Values

Supportable maintains a global list of Intake Stages which can be selected for an Offering’s intake process.

Sample Request #

Headers	Authorization = Bearer [token]
Parameters	None
Body	None

GET https://connect.supportableapp.com/api/intake-stages

Sample Response JSON #

Status: 200

[
  {
    "id": "61e855177612ad3088ec9a16",
    "status": true,
    "name": "Screening",
    "sequenceNumber": 1
  },
  {
    "id": "61e855177612ad3088ec9a17",
    "status": true,
    "name": "Assessment",
    "sequenceNumber": 2
  },
  {
    "id": "61e855177612ad3088ec9a18",
    "status": true,
    "name": "Tour",
    "sequenceNumber": 3
  },
  {
    "id": "61e855177612ad3088ec9a19",
    "status": true,
    "name": "Authorization",
    "sequenceNumber": 4
  },
  {
    "id": "61e855177612ad3088ec9a1a",
    "status": true,
    "name": "Queue",
    "sequenceNumber": 5
  }
]

Notes on Values #

Attribute	Data Type	Description
id	string	The unique identifier of the Intake Stage.
status	boolean	Whether the Intake Stage is active in Supportable.
name	string	The name of the Intake Stage as it appears in the application.
sequenceNumber	integer	The default order in which the Intake Stage appears in the list of stages.