API Reference

Get contents

get
https://{endpoint}/v1/b2b/content/sites/contents

This API allows us to obtain list of content based on various filters

Query Params
date-time

Filter content modified after this date-time. Must be in ISO 8601 UTC format (e.g. 2025-04-09T18:30:00.000Z)

boolean
Defaults to false

Include deleted records in the response

boolean
Defaults to false

Include content from deactivated sites in the response

uuid

Filter content by topic ID. Required when filter is set to "topic"

string
enum

Filter criteria for content. When set to "topic", topicId parameter is required

Allowed:
string
enum
Defaults to published

Status of content to filter. Use 'all' to fetch content with any status

Allowed:
integer
1 to 50
Defaults to 16

Number of items to return per page

uuid

Optional site ID to filter the results

string

Filter content by specific content IDs (comma-separated UUIDs)

string
enum

Sort criteria for content

string
enum

Content type filter. When event and album category is not enabled and pageCategoryId is sent, type is required and must be page. When enabled, type is optional (page, album, or event); omit type to include all three.

Allowed:
string
^(page|album|event)(,(page|album|event))*$

Multi-select content type filter as a comma-separated string (e.g. page,album,event). Requires the event/album category feature flag; ignored when the flag is off. When both type and types are sent and the flag is on, types takes precedence.

string
enum

Content sub-type filter

Allowed:
integer
≥ 0

Filter content published within specified time period in days

enum

Filter by publish date preset or custom closed [from, to] YYYY-MM-DD range as a comma-separated pair (e.g. 2026-08-02,2026-08-10). Open-ended null bounds are not accepted on query params. Custom range requires the event/album category feature flag; ignored when the flag is off. from must be <= to.

uuid

Filter by category ID. When event and album category is not enabled, type is required and must be page. When enabled, type is optional (page, album, or event); omit type to include all three.

uuid

Filter content by author ID

uuid

Filter content contributed by this user ID (authored or modified by this user)

boolean
Defaults to false

Whether the content is must read or not

integer

Token for fetching the next page of results

string
enum

Specifies which bulk operation report to generate. Use 'content_author_report_generation' for author change CSV export.

Allowed:
uuid

ID of the user who requested the bulk operation (required when reportType is provided)

string

Provide a single locale code (e.g., en-US or en-GB or fr-FR or hi-IN). Use locales of enabled languages for your tenant

Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?