getCategoryBySlug( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns a single category by URL slug.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Read Forums
Manage Forums
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
slugstringRequired

URL slug.

optionsGetCategoryBySlugOptions

Options specifying which fields to return.

Returns
Return Type:Promise<CategoryResponse>
Did this help?