Skip to content

DoCurious API Reference / types / CuratedView

Interface: CuratedView

Defined in: types/explore.types.ts:50

An admin-defined challenge collection displayed as a card or carousel on the Explore page.

Remarks

Curated views are the building blocks of the Explore page layout. Each view has embedded queryParams that the API uses to fetch the matching challenges. Views are grouped by ViewFamily and sorted by displayOrder within each family.

Example

ts
const view: CuratedView = {
  id: 'cv-001',
  createdAt: '2025-01-01T00:00:00Z',
  updatedAt: '2025-01-01T00:00:00Z',
  name: 'Weekend Warriors',
  slug: 'weekend-warriors',
  description: 'Challenges you can complete in a single weekend.',
  family: 'PRACTICAL',
  displayOrder: 1,
  isActive: true,
  queryParams: { sortBy: 'popular', limit: 12 },
}

Extends

Properties

createdAt

createdAt: string

Defined in: types/common.types.ts:154

ISO 8601 datetime when the entity was created

Inherited from

BaseEntity.createdAt


description?

optional description: string

Defined in: types/explore.types.ts:54


displayOrder

displayOrder: number

Defined in: types/explore.types.ts:59

Sort position within its family group


family

family: ViewFamily

Defined in: types/explore.types.ts:56

Which Explore page section this view belongs to


icon?

optional icon: string

Defined in: types/explore.types.ts:57


id

id: string

Defined in: types/common.types.ts:167

Inherited from

BaseEntity.id


isActive

isActive: boolean

Defined in: types/explore.types.ts:60


name

name: string

Defined in: types/explore.types.ts:51


queryParams?

optional queryParams: object

Defined in: types/explore.types.ts:63

Pre-configured filter/sort parameters used to fetch this view's challenges

categoryIds?

optional categoryIds: string[]

isFeatured?

optional isFeatured: boolean

isFree?

optional isFree: boolean

limit?

optional limit: number

sortBy?

optional sortBy: string


slug

slug: string

Defined in: types/explore.types.ts:53

URL-safe identifier used in routing


updatedAt

updatedAt: string

Defined in: types/common.types.ts:156

ISO 8601 datetime when the entity was last modified

Inherited from

BaseEntity.updatedAt

DoCurious Platform Documentation