Skip to main content
GET
/
health
/
auth
Authenticated key smoke test
curl --request GET \
  --url https://api.scripe.io/v1/health/auth \
  --header 'Authorization: Bearer <token>'
{
  "version": "<string>",
  "workspace": {
    "id": "<string>"
  },
  "principal": {
    "id": "key_a1b2c3d4e5f6g7h8",
    "scopes": [
      "<string>"
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.scripe.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Pass Authorization: Bearer scripe_sk_live_<...> (or scripe_sk_test_<...> for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard.

Headers

​
Scripe-Api-Version
string

Pin the API version. Format YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return 400 version_unsupported.

Example:

"2026-08-01"

Response

Auth succeeded.

​
status
enum<string>
required
Available options:
ok
​
version
string
required
​
workspace
object
required
​
principal
object
required