GET
/
availability
curl --request GET \
  --url https://api.usecobalt.com/v1/availability \
  --header 'access_token: <api-key>' \
  --header 'client_id: <api-key>' \
  --header 'client_secret: <api-key>'
{
  "success": true,
  "results": {
    "availability": [
      {
        "day_of_week": 123,
        "date": "<string>",
        "duration_string": "<string>",
        "range_start": "<string>",
        "range_end": "<string>",
        "provider_name": "<string>",
        "timezone_abbr": "<string>"
      }
    ]
  }
}

​
Example Request

curl -X GET https://api.usecobalt.com/v1/availability \
-H 'Content-Type: application/json' \
-H 'client_id: ci_live_198908HJDKJSH98789OHKJL' \
-H 'client_secret: cs_live_9827hofdsklOYYHJLJh' \
-H 'access_token: 493JKLHIU98789hLKH9HHJH' \
-G \
--data-urlencode "start_date=2024-03-14T00:00:00-07:00" \
--data-urlencode "end_date=2024-04-14T23:59:59-07:00" \
--data-urlencode "buffer=30" \
--data-urlencode "visit_type=np" \
--data-urlencode "calculation_method=slots" \
--data-urlencode "slot_type=Open"

​
Example Response

{
    "success": true,
    "results": {
        "availability": [
            {
                "day_of_week": 5,
                "date": "2024-04-05",
                "duration_string": "9h",
                "range_start": "2024-04-05T08:00:00.000-07:00",
                "range_end": "2024-04-05T17:00:00.000-07:00",
                "provider_name": "John Doe",
                "timezone_abbr": "PDT"
            }
        ]
    },
    "timezone": "America/Los_Angeles"
}

Authorizations

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

Query Parameters

​
start_date
string
required

The start of the date range (YYYY-MM-DD)

​
end_date
string
required

The end of the date range (YYYY-MM-DD)

​
provider_type
enum<string>
default:primary

Whether to check availability for the primary provider (default) or secondary provider

Available options:
primary,
secondary

Response

200 - application/json
Successful response
​
success
boolean
​
results
object