Seznam zákazníků

Vrátí seznam zákazníků podle daných kritérií. Podporuje stránkování, filtrování i řazení.

GEThttps://app.mwork365.com/main/publicapi/customer?page=1&pageSize=20

Parametry

pageintegerpovinné

Číslo stránky. První stránka má číslo 1

pageSizeintegerpovinné

Počet záznamů na stránce. Maximální velikost stránky je 200

searchPhrasestring

Hledaná fráze. Ignoruje velikost písmen i diakritiku.

sortBystring

Název sloupce, podle kterého se mají data seřadit. Podporované sloupce:

• name
• identificationNumber
• taxNumber
• address
• kind
• typeName
• categoryName
• ownerName
• created
• modified

sortOrder"ascend" | "descend"

Způsob řazení. Výchozí způsob je vzestupné řazení

categoryIdstring

Filtrovat podle ID kategorie.
Je možné uvést více hodnot oddělených čárkou.

Upozornění

Filtrování podporuje pouze ID, nelze filtrovat podle Slugu

customerTypeIdstring

Filtrovat podle typu zákazníka.
Je možné uvést více hodnot oddělených čárkou.

Upozornění

Filtrování podporuje pouze ID, nelze filtrovat podle Slugu

ownerIdstring

Filtrovat podle ID vlastníka. Vlastník je uživatel, který zákazníka založil. Vlastník zákazníka jde změnit. Zákazník založená automaticky, například pomocí API má jako vlastníka administrátora firmy.
Je možné uvést více hodnot oddělených čárkou.

Odpověď

200 OK

Stránkovaný seznam zákazníků
Response Body: objekt s poli total (integer) a data (Customer[]).

400, 401, atd.

Více informací o standardních chybových stavech

Příklad

curl -L -X GET 'https://app.mwork365.com/main/publicapi/customer?page=1&pageSize=10' \
-H 'Authorization: Bearer eyJhb...WlUw'