Blogs::Category

List Blog Categories

Changed on

List the categories within the given blog.

get/blogs/{blog_id}/categories

Request

Path parameters

blog_idstring required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger

Category ID

public_idstring

The public identifier of the category

blog_idinteger

Blog ID that the category belongs to

namestring

Category name

current_pathstring nullable

The current path of the category

created_atstring date-time

Created at

updated_atstring date-time

Updated at

urlstring nullable

The full public URL of the category

Example response

[
  {
    "id": 1,
    "public_id": "cAbCdE",
    "blog_id": 1,
    "name": "Tutorials",
    "current_path": "/blog/category/tutorials",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z",
    "url": "https://myworkspace.myclickfunnels.com/blog/category/tutorials"
  }
]

Changes

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • info

      added the new optional query request parameter per_page

    • info

      for the path request parameter blog_id, the type was generalized from integer to string

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status