Skip to content

List Posts by Type

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

Internal proxy to GET /api/v1/posts?type={key}. Forwards query params (page, limit, lang, status, …). Not a 302 redirect.

Parameters

Path Parameters

key*

type_key of the post type

Type
string
Required

Query Parameters

page
Type
integer
Minimum
1
Default
1
limit
Type
integer
Minimum
1
Maximum
100
Default
10
lang
Type
string
status
Type
string
q
Type
string

Responses

Posts list (same envelope as blogListPosts)

Playground

Server
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

List posts for a type. Internal proxy to GET /api/v1/posts?type={key} (not a redirect).

Auth: optional (same as blog list posts).

Parameters

NameInTypeRequiredDescription
keypathstringYestype_key
pagequerynumberNoPage number
limitquerynumberNoItems per page
langquerystringNoLanguage filter
statusquerystringNoStatus filter
qquerystringNoText search

Request Body

None.

Response 200

json
{
	"data": [],
	"user_context": { "authenticated": false },
	"meta": { "page": 1, "limit": 10, "total": 0, "hasMore": false }
}

Response Errors

  • 400 invalid query parameters
  • 503 MODULE_DISABLED

Notes

  • Forwards listing query params to the Blog posts list with type set.
  • Prefer GET /api/v1/posts?type= directly when you already use the Blog client.