Skip to main content
GET
/
visit-statuses
Get Visit Statuses
curl --request GET \
  --url https://api.usecobalt.com/v1/visit-statuses \
  --header 'access_token: <api-key>' \
  --header 'client_id: <api-key>' \
  --header 'client_secret: <api-key>'
{
  "success": true,
  "data": [
    {
      "code": "<string>",
      "description": "<string>"
    }
  ]
}

​
Example Request

curl -X GET https://api.usecobalt.com/v1/visit-types \
-H 'Content-Type: application/json' \
-H 'client_id: ci_live_198908HJDKJSH98789OHKJL' \
-H 'client_secret: cs_live_9827hofdsklOYYHJLJh' \
-H 'access_token: 493JKLHIU98789hLKH9HHJH'

​
Example Response

{
    "success": true,
    "data": [
        {
            "code": "CANC",
            "description": "Cancelled in advance"
        },
        {
            "code": "R/S",
            "description": "Rescheduled"
        }
    ]
}
This endpoint returns a list of all visit statuses configured for the account associated with the provided access token. Each status type includes a code and a description. The code can be used in our PATCH /appointments endpoint to update the status of an appointment.

Authorizations

​
client_id
string
header
required
​
client_secret
string
header
required
​
access_token
string
header
required

Response

200 - application/json

Successful response

​
success
boolean
​
data
object[]