Správa uživatelů: založení, úprava, aktivace, deaktivace, smazání a výpisy podrobností. Prostředí, klíč v hlavičce X-Api-Key, stránkování a čtení tabulek popisuje Public API – základy. Dokumentace odpovídá stavu API k 6. 8. 2026.
POST /v2/user/activate-application
Lze aktivovat pomocí ID uživatele přístup do aplikace.
Je vráceno potvrzení o dokončení aktivace přístupu do aplikace.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
userId (povinné) | Unikátní identifikátor uživatele v systému Fidoo. | 0cf6e5c1-3c77-4383-9a86-6fef12d9f62b |
email | E-mailová adresa uživatele. | jan.novak@example.com |
POST /v2/user/activate-user
Lze aktivovat existujícího uživatele pomocí ID uživatele.
Je vráceno potvrzení o provedení aktivace uživatele.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
userId (povinné) | Unikátní identifikátor uživatele v systému Fidoo. | 0cf6e5c1-3c77-4383-9a86-6fef12d9f62b |
POST /v2/user/deactivate-user
Lze deaktivovat existujícího uživatele pomocí ID uživatele.
Je vráceno potvrzení o dokončení aktivace přístupu do aplikace.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
userId (povinné) | Unikátní identifikátor uživatele v systému Fidoo. | 0cf6e5c1-3c77-4383-9a86-6fef12d9f62b |
POST /v2/user/add-user
Lze přidat nového uživatele, ihned jej aktivovat a přiřadit mi přístup do aplikace.
Je vráceno přidělení ID nově přidaného uživatele.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
active | Indikátor, zda přidávaný uživatel má být zároveň aktivován. Hodnoty: true = uživatel po přidání bude aktivní; false = uživatel po přidání bude deaktivovaný. | true |
firstName (povinné) | Jméno uživatele. | Jan |
lastName (povinné) | Příjmení uživatele. | Novák |
email (povinné) | E-mailová adresa uživatele. | jan.novak@example.com |
phone (povinné) | Telefon uživatele. | +420605562478 |
employeeNumber | Zaměstnanecké číslo uživatele. | AX12545 |
position | Pozice uživatele ve své společnosti. | Účetní |
usesApplication | Indikátor, zda má uživatel přístup do aplikace. Hodnoty: true = uživatel s přístupem do aplikace; false = uživatel bez přístupu do aplikace. | true |
language (povinné) | Jazyk prostředí aplikace daného uživatele. Hodnoty: cs = aplikace v jazyku Čeština; en = aplikace v jazyku Angličtina. | cs |
costCenterId | Unikátní identifikátor nákladového střediska v systému Fidoo. | d4a7fbfb-0531-4ff4-81a7-cf0a3315a975 |
projectId | Unikátní identifikátor projektu v systému Fidoo. | 0b20bf11-9282-4a98-97e7-85b3d02daa82 |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
userId | Unikátní identifikátor uživatele v systému Fidoo. | 0cf6e5c1-3c77-4383-9a86-6fef12d9f62b |
POST /v2/user/delete-user
Lze smazat uživatele pomocí ID uživatele.
Je vráceno potvrzení o provedení smazání uživatele.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
userId (povinné) | Unikátní identifikátor uživatele v systému Fidoo. | 0cf6e5c1-3c77-4383-9a86-6fef12d9f62b |
POST /v2/user/get-user
Lze zjistit podrobnosti o uživateli jako např. stav uživatele, KYC stav, zda má přístup do aplikace, přiřazené nákladové středisko či projekt.
Jsou vráceny podrobnosti o uživateli na základě jeho ID.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
userId (povinné) | Unikátní identifikátor uživatele v systému Fidoo. | 0cf6e5c1-3c77-4383-9a86-6fef12d9f62b |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
firstName | Jméno uživatele. | Jan |
lastName | Příjmení uživatele. | Novák |
email | E-mailová adresa uživatele. | jan.novak@example.com |
phone | Telefon uživatele. | +420605562478 |
employeeNumber | Zaměstnanecké číslo uživatele. | AX12545 |
userState | Stav uživatele. Hodnoty: active = Aktivní uživatel; new = Nový uživatel; deleted = Smazaný uživatel (nezobrazuje se v aplikaci). | active |
kycStatus | Stav procesu identifikace uživatele. Hodnoty: ok = uživatel ověřen (potvrzená identifikace); failed; refused = zamítnutá identifikace; unknown = proces identifikace nezahájen. | ok |
language | Jazyk prostředí aplikace daného uživatele. Hodnoty: cs = aplikace v jazyku Čeština; en = aplikace v jazyku Angličtina. | cs |
userId | Unikátní identifikátor uživatele v systému Fidoo. | 30dcca40-9858-4139-9230-bb86d97cf64e |
position | Pozice uživatele ve své společnosti. | Účetní |
usesApplication | Indikátor, zda má uživatel přístup do aplikace. Hodnoty: true = uživatel s přístupem do aplikace; false = uživatel bez přístupu do aplikace. | true |
deactivated | Indikátor, zda je uživatel deaktivovaný. Hodnoty: true = uživatel je deaktivovaný; false = uživatel není deaktivovaný. | false |
costCenterId | Unikátní identifikátor nákladového střediska v systému Fidoo. | d4a7fbfb-0531-4ff4-81a7-cf0a3315a975 |
projectId | Unikátní identifikátor projektu v systému Fidoo. | 0b20bf11-9282-4a98-97e7-85b3d02daa82 |
POST /v2/user/get-user-by-email
Lze zjistit podrobnosti o uživateli jako např. stav uživatele, KYC stav, zda má přístup do aplikace, přiřazené nákladové středisko či projekt.
Jsou vráceny podrobnosti o uživateli na základě jeho e-mailu.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
email (povinné) | E-mailová adresa uživatele. | jan.novak@example.com |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
firstName | Jméno uživatele. | Jan |
lastName | Příjmení uživatele. | Novák |
email | E-mailová adresa uživatele. | jan.novak@example.com |
phone | Telefon uživatele. | +420605562478 |
employeeNumber | Zaměstnanecké číslo uživatele. | AX12545 |
userState | Stav uživatele. Hodnoty: active = Aktivní uživatel; new = Nový uživatel; deleted = Smazaný uživatel (nezobrazuje se v aplikaci). | active |
kycStatus | Stav procesu identifikace uživatele. Hodnoty: ok = uživatel ověřen (potvrzená identifikace); failed; refused = zamítnutá identifikace; unknown = proces identifikace nezahájen. | ok |
language | Jazyk prostředí aplikace daného uživatele. Hodnoty: cs = aplikace v jazyku Čeština; en = aplikace v jazyku Angličtina. | cs |
userId | Unikátní identifikátor uživatele v systému Fidoo. | 30dcca40-9858-4139-9230-bb86d97cf64e |
position | Pozice uživatele ve své společnosti. | Účetní |
usesApplication | Indikátor, zda má uživatel přístup do aplikace. Hodnoty: true = uživatel s přístupem do aplikace; false = uživatel bez přístupu do aplikace. | true |
deactivated | Indikátor, zda je uživatel deaktivovaný. Hodnoty: true = uživatel je deaktivovaný; false = uživatel není deaktivovaný. | false |
costCenterId | Unikátní identifikátor nákladového střediska v systému Fidoo. | d4a7fbfb-0531-4ff4-81a7-cf0a3315a975 |
projectId | Unikátní identifikátor projektu v systému Fidoo. | 0b20bf11-9282-4a98-97e7-85b3d02daa82 |
POST /v2/user/get-user-by-employee-number
Lze zjistit podrobnosti o uživateli jako např. stav uživatele, KYC stav, zda má přístup do aplikace, přiřazené nákladové středisko či projekt.
Jsou vráceny podrobnosti o uživateli na základě jeho zaměstnaneckého čísla.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
employeeNumber (povinné) | Zaměstnanecké číslo uživatele. | AX12545 |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
firstName | Jméno uživatele. | Jan |
lastName | Příjmení uživatele. | Novák |
email | E-mailová adresa uživatele. | jan.novak@example.com |
phone | Telefon uživatele. | +420605562478 |
employeeNumber | Zaměstnanecké číslo uživatele. | AX12545 |
userState | Stav uživatele. Hodnoty: active = Aktivní uživatel; new = Nový uživatel; deleted = Smazaný uživatel (nezobrazuje se v aplikaci). | active |
kycStatus | Stav procesu identifikace uživatele. Hodnoty: ok = uživatel ověřen (potvrzená identifikace); failed; refused = zamítnutá identifikace; unknown = proces identifikace nezahájen. | ok |
language | Jazyk prostředí aplikace daného uživatele. Hodnoty: cs = aplikace v jazyku Čeština; en = aplikace v jazyku Angličtina. | cs |
userId | Unikátní identifikátor uživatele v systému Fidoo. | 30dcca40-9858-4139-9230-bb86d97cf64e |
position | Pozice uživatele ve své společnosti. | Účetní |
usesApplication | Indikátor, zda má uživatel přístup do aplikace. Hodnoty: true = uživatel s přístupem do aplikace; false = uživatel bez přístupu do aplikace. | true |
deactivated | Indikátor, zda je uživatel deaktivovaný. Hodnoty: true = uživatel je deaktivovaný; false = uživatel není deaktivovaný. | false |
costCenterId | Unikátní identifikátor nákladového střediska v systému Fidoo. | d4a7fbfb-0531-4ff4-81a7-cf0a3315a975 |
projectId | Unikátní identifikátor projektu v systému Fidoo. | 0b20bf11-9282-4a98-97e7-85b3d02daa82 |
POST /v2/user/get-users
Lze zjistit podrobnosti o vícero uživatelích jako např. stav uživatele, KYC stav, zda mají přístup do aplikace, přiřazena nákladová střediska či přidělení k projektům.
Je vrácen seznam uživatelů podle fulltextového vyhledávání či se změnou v daném časovém rozpětí.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
fulltext | Fulltextové vyhledávání. | Jan |
states | Stav uživatele. Hodnoty: activeUser = Aktivní uživatel; newUser = Nový uživatel; deletedUser = Smazaný uživatel (nezobrazuje se v aplikaci). | activeUser |
from | Počáteční datum pro filtrování uživatelů. Uveden ve formátu ISO 8601. | 2023-04-01T01:00:00Z |
to | Konečné datum pro filtrování uživatelů. Uveden ve formátu ISO 8601. | 2023-04-30T23:59:99Z |
limit | Maximální počet vrácených řádků (uživatelů). Výchozí hodnota je 100. | 100 |
offsetToken | Klíč pro vícenásobné volání. Uveden jako hodnota parametru nextOffsetToken vraceného do nabytí stavu "complete": true. | T3 |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
userList | Výpis uživatelů. | – |
· userId | Unikátní identifikátor uživatele v systému Fidoo. | 30dcca40-9858-4139-9230-bb86d97cf64e |
· firstName | Jméno uživatele. | Jan |
· lastName | Příjmení uživatele. | Novák |
· email | E-mailová adresa uživatele. | jan.novak@example.com |
· phone | Telefon uživatele. | +420605562478 |
· companyId | Unikátní identifikátor společnosti v systému Fidoo. | r6417d750-2f6a-11e9-b210-d663bd873d93 |
· employeeNumber | Zaměstnanecké číslo uživatele. | AX12545 |
· position | Pozice uživatele ve své společnosti. | Účetní |
· userState | Stav uživatele. Hodnoty: active = Aktivní uživatel; new = Nový uživatel; deleted = Smazaný uživatel (nezobrazuje se v aplikaci). | active |
· deactivated | Indikátor, zda je uživatel deaktivovaný. Hodnoty: true = uživatel je deaktivovaný; false = uživatel není deaktivovaný. | false |
· lastModified | Datum poslední úpravy uživatele. Uvedeno ve formátu ISO 8601. | 2023-08-29T17:52:34.321Z |
· usesApplication | Indikátor, zda má uživatel přístup do aplikace. Hodnoty: true = uživatel s přístupem do aplikace; false = uživatel bez přístupu do aplikace. | true |
· language | Jazyk prostředí aplikace daného uživatele. Hodnoty: cs = aplikace v jazyku Čeština; en = aplikace v jazyku Angličtina. | cs |
complete | Stav dokončení kompletního výpisu. Hodnoty: true = výpis je kompletní (dokončen); false = výpis není kompletní. | false |
nextOffsetToken | Klíč pro vícenásobné volání. | T3 |
POST /v2/user/update-user
Lze upravit vlastnosti uživatele jako zaměstnanecké číslo, pozici, jazyk aplikace, nákladové středisko či přidělení k projektu.
Je vráceno potvrzení o úpravě uživatele.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
userId (povinné) | Unikátní identifikátor uživatele v systému Fidoo. | 0cf6e5c1-3c77-4383-9a86-6fef12d9f62b |
firstName | Jméno uživatele. | Jan |
lastName | Příjmení uživatele. | Novák |
employeeNumber | Zaměstnanecké číslo uživatele. | AX12545 |
position | Pozice uživatele ve své společnosti. | Účetní |
language | Jazyk prostředí aplikace daného uživatele. Hodnoty: cs = aplikace v jazyku Čeština; en = aplikace v jazyku Angličtina. | cs |
costCenterId | Unikátní identifikátor nákladového střediska v systému Fidoo. | d4a7fbfb-0531-4ff4-81a7-cf0a3315a975 |
projectId | Unikátní identifikátor projektu v systému Fidoo. | 0b20bf11-9282-4a98-97e7-85b3d02daa82 |
Byl tento článek užitečný?