Skip to content
Canverly for developers

GET /v1/post-types

List the post types configured on the site that owns the API key. Use it to discover which post_type slugs are valid before calling POST /v1/posts. post and page always exist.

  • URL: https://api.canverly.com/v1/post-types
  • Method: GET
  • Auth: Bearer API key — scope post_types:read
  • Rate limit: 60 req/min per key

The site is inferred from the key — there are no query parameters.

Example

Section titled “Example”
Janela do terminal
curl https://api.canverly.com/v1/post-types \
  -H "Authorization: Bearer ck_live_xxx"

Response

Section titled “Response”

200 OK

Section titled “200 OK”
{
  "items": [
    {
      "id": "5BXZ3FZSDR98MT85BY1S0ECEYY",
      "slug": "post",
      "name": "Post",
      "plural_name": "Posts",
      "description": "",
      "is_default": true,
      "public": true,
      "hierarchical": false,
      "has_archive": true,
      "supports": ["title", "editor", "excerpt", "thumbnail", "revisions", "author", "comments"],
      "fields": [],
      "schema": null,
      "sidebar_icon": "file-text",
      "sidebar_order": 10,
      "site_id": "01KVPWYKT6AJDGG2EJN7DW4VT5",
      "org_id": "01KTBNJYSF1N1WQGX2VEZ1G0FZ",
      "created_at": "2026-06-22T05:30:46.989Z",
      "updated_at": "2026-06-22T05:30:46.989Z"
    },
    {
      "id": "7PB34VRMAJ844AN186C9Z74Z0P",
      "slug": "page",
      "name": "Página",
      "plural_name": "Páginas",
      "is_default": true,
      "public": true,
      "hierarchical": true,
      "has_archive": false,
      "supports": ["title", "editor", "thumbnail", "revisions"],
      "fields": [],
      "schema": null
    }
  ]
}
Field Type Notes
slug string Use this as post_type on POST /v1/posts.
name / plural_name string Display labels.
is_default boolean true for the built-in post/page.
hierarchical boolean true for page-like types (parent/child).
has_archive boolean Whether the type has a public archive listing.
supports string[] Editor capabilities the type enables.
fields array Custom field definitions (for custom post types).
schema object | null JSON schema for custom fields, when defined.

Errors

Section titled “Errors”
Status error.code When
401 unauthorized Missing/invalid key.
403 forbidden Key lacks post_types:read.
429 rate_limited Over 60 req/min.

See also

Section titled “See also”