Skip to main content
GET
Zoznam obchodných prípadov

Autorizace

Authorization
string
header
povinné

Bearer token vytvorený pre konkrétnu firmu v Integrácie → API.

Parametry dotazu

clientId
integer

Filter podľa klienta patriaceho. Pole je vzájomne exkluzívne so supplierId.

Příklad:

101

supplierId
integer

Filter podľa dodávateľa patriaceho. Pole je vzájomne exkluzívne s clientId.

Příklad:

151

statusId
integer | null

Filter podľa stavu obchodného prípadu.

Příklad:

41

Fulltextové vyhľadávanie podľa názvu alebo popisu obchodného prípadu.

Maximum string length: 255
Příklad:

"keyword"

sortBy
enum<string>
výchozí:id

Pole, podľa ktorého sa majú obchodné prípady zoradiť.

Dostupné možnosti:
name,
createdAt,
updatedAt,
boardPosition
Příklad:

"updatedAt"

sortDirection
enum<string>
výchozí:desc

Smer zoradenia.

Dostupné možnosti:
asc,
desc
Příklad:

"desc"

perPage
integer
výchozí:10

Počet výsledkov na stránku. Maximum je 200.

Požadovaný rozsah: 1 <= x <= 200
Příklad:

10

page
integer
výchozí:1

Číslo stránky, ktorá sa má vrátiť.

Požadovaný rozsah: x >= 1
Příklad:

1

Odpověď

Zoznam obchodných prípadov.

data
object[]

Zoznam obchodných prípadov.

paginator
object

Paginator pre aktuálny výsledkový set.