getPostBySlug( )


Developer Preview

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

Retrieves a single post 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
function getPostBySlug(
  slug: string,
  options: GetPostBySlugOptions,
): Promise<PostResponse>;
Method Parameters
slugstringRequired

URL slug.


optionsGetPostBySlugOptions

Options specifying which additional fields to return.

Returns
Return Type:Promise<PostResponse>
JavaScript
import { posts } from "wix-forum.v2"; async function getPostBySlug(slug, options) { try { const result = await posts.getPostBySlug(slug, options); return result; } catch (error) { console.error(error); // Handle the error } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?