Ghost · Schema

User

A staff user account in the Ghost publication.

PublishingNewslettersMembershipsContentOpen Source

Properties

Name	Type	Description
id	string	Unique identifier
name	string	Display name
slug	string	URL-safe slug
email	string	Email address
profile_image	string	Profile image URL
cover_image	string	Cover image URL
bio	string	Biography
website	string	Personal website URL
location	string	Location
facebook	string	Facebook username
twitter	string	Twitter handle
accessibility	string	Accessibility settings JSON
status	string	User account status
meta_title	string	SEO meta title
meta_description	string	SEO meta description
tour	string	Onboarding tour progress JSON
last_seen	string	Last login timestamp
url	string	Full URL of the author page
roles	array	Assigned roles
created_at	string	Account creation timestamp
updated_at	string	Last update timestamp

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/User",
  "title": "User",
  "type": "object",
  "description": "A staff user account in the Ghost publication.",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier"
    },
    "name": {
      "type": "string",
      "description": "Display name"
    },
    "slug": {
      "type": "string",
      "description": "URL-safe slug"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address"
    },
    "profile_image": {
      "type": "string",
      "format": "uri",
      "description": "Profile image URL",
      "nullable": true
    },
    "cover_image": {
      "type": "string",
      "format": "uri",
      "description": "Cover image URL",
      "nullable": true
    },
    "bio": {
      "type": "string",
      "description": "Biography",
      "nullable": true
    },
    "website": {
      "type": "string",
      "format": "uri",
      "description": "Personal website URL",
      "nullable": true
    },
    "location": {
      "type": "string",
      "description": "Location",
      "nullable": true
    },
    "facebook": {
      "type": "string",
      "description": "Facebook username",
      "nullable": true
    },
    "twitter": {
      "type": "string",
      "description": "Twitter handle",
      "nullable": true
    },
    "accessibility": {
      "type": "string",
      "description": "Accessibility settings JSON",
      "nullable": true
    },
    "status": {
      "type": "string",
      "description": "User account status",
      "enum": [
        "active",
        "inactive",
        "locked"
      ]
    },
    "meta_title": {
      "type": "string",
      "nullable": true,
      "description": "SEO meta title"
    },
    "meta_description": {
      "type": "string",
      "nullable": true,
      "description": "SEO meta description"
    },
    "tour": {
      "type": "string",
      "description": "Onboarding tour progress JSON",
      "nullable": true
    },
    "last_seen": {
      "type": "string",
      "format": "date-time",
      "description": "Last login timestamp",
      "nullable": true
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Full URL of the author page"
    },
    "roles": {
      "type": "array",
      "description": "Assigned roles",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Role identifier"
          },
          "name": {
            "type": "string",
            "description": "Role name"
          },
          "description": {
            "type": "string",
            "description": "Role description"
          }
        }
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Account creation timestamp"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Last update timestamp"
    }
  }
}