Skip to main content
GET
/
post-statuses
List the workspace's custom post statuses
curl --request GET \
  --url https://api.scripe.io/v1/post-statuses \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "color": "<string>",
      "order": 123,
      "isDefault": true
    }
  ]
}

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

All custom statuses for the workspace.

​
data
object[]
required