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.

Admin Method

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Forums
Manage Forums
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
slugstringRequired

URL slug.


optionsGetCategoryBySlugOptions

Options specifying which fields to return.

Returns
Return Type:Promise<CategoryResponse>
Was this helpful?
Yes
No