Skip to main content

api

Workspace API

Workspace API / types/api

types/api

Interfaces​

ApiResponse​

Defined in: types/api.ts:2

Type Parameters​

T​

T = any

Properties​

success​

success: boolean

Defined in: types/api.ts:3

data?​

optional data: T

Defined in: types/api.ts:4

message?​

optional message: string

Defined in: types/api.ts:5

error?​

optional error: string

Defined in: types/api.ts:6

PaginatedResponse​

Defined in: types/api.ts:9

Type Parameters​

T​

T = any

Properties​

success​

success: boolean

Defined in: types/api.ts:10

data?​

optional data: T[]

Defined in: types/api.ts:11

total?​

optional total: number

Defined in: types/api.ts:12

limit?​

optional limit: number

Defined in: types/api.ts:13

offset?​

optional offset: number

Defined in: types/api.ts:14

message?​

optional message: string

Defined in: types/api.ts:15

ErrorResponse​

Defined in: types/api.ts:18

Properties​

success​

success: false

Defined in: types/api.ts:19

message​

message: string

Defined in: types/api.ts:20

error?​

optional error: string

Defined in: types/api.ts:21

code?​

optional code: string

Defined in: types/api.ts:22

PaginationParams​

Defined in: types/api.ts:26

Properties​

limit?​

optional limit: number

Defined in: types/api.ts:27

offset?​

optional offset: number

Defined in: types/api.ts:28

SearchParams​

Defined in: types/api.ts:31

Properties​

optional search: string

Defined in: types/api.ts:32

SortParams​

Defined in: types/api.ts:35

Properties​

sortBy?​

optional sortBy: string

Defined in: types/api.ts:36

sortOrder?​

optional sortOrder: "asc" | "desc"

Defined in: types/api.ts:37

DateRangeParams​

Defined in: types/api.ts:41

Properties​

startDate?​

optional startDate: string

Defined in: types/api.ts:42

endDate?​

optional endDate: string

Defined in: types/api.ts:43

StatusParams​

Defined in: types/api.ts:46

Properties​

status?​

optional status: string

Defined in: types/api.ts:47