Get Post Type

GET

/api/v1/post-types/{key}

Returns one post type definition by type_key.

Parameters

Path Parameters

key*

type_key of the post type

Type

string

Required

Responses

Type definition

Content-Type

application/json

{

  

"data": {

  

  

"id": "string",

  

  

"type_key": "case-study",

  

  

"type_name": "Case Study",

  

  

"description": "string",

  

  

"slug_prefix": "string",

  

  

"field_schema": [

  

  

  

{

  

  

  

  

"name": "string",

  

  

  

  

"label": "string",

  

  

  

  

"type": "string",

  

  

  

  

"required": true,

  

  

  

  

"options": [

  

  

  

  

  

"string"

  

  

  

  

],

  

  

  

  

"max_length": 0,

  

  

  

  

"placeholder": "string"

  

  

  

}

  

  

],

  

  

"behaviors": {

  

  

  

"public_by_default": true,

  

  

  

"enables_seo": true,

  

  

  

"enables_comments": true,

  

  

  

"enables_reactions": true,

  

  

  

"enables_bookmarks": true,

  

  

  

"enables_views": true,

  

  

  

"enables_scheduling": true,

  

  

  

"requires_approval": true,

  

  

  

"allows_password_visibility": true,

  

  

  

"default_visibility": "string",

  

  

  

"allowed_body_formats": [

  

  

  

  

"string"

  

  

  

],

  

  

  

"max_per_author": 0,

  

  

  

"additionalProperties": "string"

  

  

},

  

  

"icon": "string",

  

  

"color": "string",

  

  

"is_active": true,

  

  

"is_built_in": true,

  

  

"sort_order": 0,

  

  

"created_at": "string",

  

  

"updated_at": "string"

  

}

}

GET

/api/v1/post-types/{key}

Playground

Server

Variables

Key

Value

key*

Samples

Powered by VitePress OpenAPI

Get one post type definition by type_key.

Auth: public.

Parameters

Name	In	Type	Required	Description
key	path	string	Yes	type_key

Request Body

None.

Response 200

{
	"data": {
		"type_key": "case-study",
		"type_name": "Case Study",
		"field_schema": [],
		"behaviors": {},
		"is_active": true,
		"is_built_in": false
	}
}

Response Errors

• 404 type not found
• 503 MODULE_DISABLED

Notes

• Use for admin detail views and type-aware editors.
• Prefer /schema when you only need editor fields + behaviors.