Get Settings

Returns the current settings for the associated access token.

GET /settings

Get Settings

cURL

curl --request GET \
  --url https://api.usecobalt.com/v1/settings \
  --header 'access_token: <api-key>' \
  --header 'client_id: <api-key>' \
  --header 'client_secret: <api-key>'

200

{
  "success": true,
  "data": {
    "access_token_reference_id": "<string>",
    "visit_types": [
      "<string>"
    ],
    "timezone": "<string>"
  }
}

Example Request

curl -X GET https://api.usecobalt.com/v1/settings \
-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": {
        "access_token_reference_id": "at_ref_123456789",
        "visit_types": [
            {
                "code": "new_patient",
                "description": "New Patient Visit (in-person)"
            },
            {
                "code": "televisit1",
                "description": "televisit1 (televisit / osa)"
            }
        ],
        "visit_statuses": [
            {
                "code": "CANC",
                "description": "Cancelled in advance"
            },
            {
                "code": "R/S",
                "description": "Rescheduled"
            }
        ],
        "required_patient_fields": [
            "first_name", 
            "last_name", 
            "dob", 
            "sex"
        ],
        "timezone": "America/New_York"
    }
}

Settings include the access token reference ID, available visit types (with codes and descriptions), and the user’s timezone. If settings are not found for the user, a 404 error will be returned.

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

Show child attributes