Interface: ListOptions

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:524

List options

Extends

• PaginationOptions

Properties

cursor?

optional cursor?: string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:407

Cursor for cursor-based pagination

Inherited from

PaginationOptions.cursor

---

expand?

optional expand?: string[]

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:543

Relations to expand

---

fields?

optional fields?: string[]

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:538

Fields to include

---

filters?

optional filters?: Record<string, any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:533

Filters

---

limit?

optional limit?: number

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:402

Items per page

Default

20

Inherited from

PaginationOptions.limit

---

page?

optional page?: number

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:396

Page number (1-based)

Default

1

Inherited from

PaginationOptions.page

---

search?

optional search?: string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:528

Search query

---

sortBy?

optional sortBy?: string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:412

Sort field

Inherited from

PaginationOptions.sortBy

---

sortOrder?

optional sortOrder?: "asc" | "desc"

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:418

Sort order

Default

'desc'

Inherited from

PaginationOptions.sortOrder