# (COMING SOON!) List Story Boards

🚧 Coming Soon — This endpoint is not yet available for external consumption.

Retrieve a paginated list of Story Boards. Supports cursor-based pagination, search by title/description, sorting, and filtering by publish status and locale.

Access Control:
- Only Story Boards the user has view access to are returned
- If the user does not have the viewStoryboards role privilege, an empty array is returned
- Only published boards are returned unless the user has Story Board management permission
- Permissions (canDelete, canApplySecurityTemplates, canShareInternal, canShareExternal, canPublish) are resolved server-side based on the user's role privileges and security template permissions

Pagination:
- Uses cursor-based pagination for consistent results across large and changing lists
- Always use the same sortBy and sortOrder values across all pages of a paginated request
- If sort parameters change, discard the current cursor and start a new request

The user submitting the request must have the viewStoryboards role privilege.

Endpoint: GET /storyboards
Version: 1.5
Security: ApiKeyAuth, BasicAuth

## Header parameters:

  - `Authorization` (string, required)
    Bearer token from authentication.

  - `X-API-Key` (string, required)
    Customer-specific API key required to invoke API.

## Query parameters:

  - `cursor` (string)
    Cursor for pagination. Omit on the first request. Use the nextCursor value from the previous response for subsequent pages.

  - `limit` (integer)
    Number of results to return per page. Defaults to 50. Maximum 100.
    Example: 50

  - `search` (string)
    Search term for filtering by title and description (partial, case-insensitive match).
    Example: "fashion"

  - `sortBy` (string)
    Field to sort by. Defaults to updatedAt.
    Enum: "updatedAt", "title"

  - `sortOrder` (string)
    Sort direction. Defaults to desc.
    Enum: "asc", "desc"

  - `status` (string)
    Filter by publish status. Defaults to all for users with management permission.
    Enum: "all", "published", "unpublished"

  - `locale` (string)
    Filter by locale. Defaults to returning all locales if omitted.
    Example: "en"

## Response 200 fields (application/json):

  - `items` (array)
    Array of Story Board objects.

  - `items.id` (string)
    Unique ID of the Story Board.

  - `items.title` (string)
    Display title of the Story Board.

  - `items.description` (string,null)
    Description of the Story Board. Null if not set.

  - `items.isPublished` (boolean)
    Whether the Story Board is currently published.

  - `items.locale` (string)
    Locale of the Story Board. Defaults to "en" if not set.

  - `items.hero` (object)
    Hero/banner image configuration.

  - `items.hero.assetId` (string,null)
    Asset ID of the hero image.

  - `items.hero.imageUrl` (string,null)
    Resolved URL of the hero image.

  - `items.hero.bannerFocusX` (number,null)
    Horizontal focal point percentage (0-100).

  - `items.hero.bannerFocusY` (number,null)
    Vertical focal point percentage (0-100).

  - `items.counts` (object)
    Resolved content block counts.

  - `items.counts.collections` (integer)
    Number of collection blocks.

  - `items.counts.savedSearches` (integer)
    Number of saved search blocks.

  - `items.counts.totalBlocks` (integer)
    Total number of content blocks.

  - `items.createdBy` (object)
    User who created the Story Board.

  - `items.createdBy.userId` (string,null)

  - `items.createdBy.firstName` (string,null)

  - `items.createdBy.lastName` (string,null)

  - `items.createdBy.avatarUrl` (string,null)

  - `items.updatedBy` (object)
    User who last updated the Story Board.

  - `items.timestamps` (object)
    Creation and update timestamps.

  - `items.timestamps.createdAt` (string,null)
    ISO 8601 creation date.

  - `items.timestamps.updatedAt` (string,null)
    ISO 8601 last updated date.

  - `items.timestamps.updatedEpoch` (integer)
    Last updated timestamp in Unix milliseconds.

  - `items.permissions` (object)
    Resolved permissions for the current user on this Story Board.

  - `items.permissions.canApplySecurityTemplates` (boolean)

  - `items.permissions.canDelete` (boolean)

  - `items.permissions.canShareInternal` (boolean)

  - `items.permissions.canShareExternal` (boolean)

  - `items.permissions.canPublish` (boolean)

  - `pageInfo` (object)
    Pagination metadata.

  - `pageInfo.nextCursor` (string,null)
    Cursor for the next page. Null if no more pages.

  - `pageInfo.hasNextPage` (boolean)
    Whether there are more results after this page.

  - `pageInfo.totalCount` (integer)
    Total number of Story Boards matching the query.

## Response 401 fields (application/json):

  - `message` (string)

  - `detail` (string)

## Response 403 fields (application/json):

  - `message` (string)

  - `detail` (string)