Request
- Base URLhttps://my.clockodo.com/api
- URLhttps://my.clockodo.com/api/v3/users/{id}
- Auth
- HTTP basic and API key in header X-Clockodo-External-Application
- or API key in header X-ClockodoApiUser and API key in header X-ClockodoApiKey and API key in header X-Clockodo-External-Application
- or OAuth 2Authorization code: /oauth/authorizeToken URL: /token
Path parameters
Request body
Possible values:
- worker: Worker
- owner: Administrator
Possible values:
- en: English
- fr: French
- de: German
Use 12h time format?
Possible values:
- Africa/Abidjan: AfricaAbidjan
- Africa/Accra: AfricaAccra
- Africa/Addis_Ababa: AfricaAddisAbaba
- Africa/Algiers: AfricaAlgiers
- Africa/Asmara: AfricaAsmara
- Africa/Bamako: AfricaBamako
- Africa/Bangui: AfricaBangui
- Africa/Banjul: AfricaBanjul
- Africa/Bissau: AfricaBissau
- Africa/Blantyre: AfricaBlantyre
- Africa/Brazzaville: AfricaBrazzaville
- Africa/Bujumbura: AfricaBujumbura
- Africa/Cairo: AfricaCairo
- Africa/Casablanca: AfricaCasablanca
- Africa/Ceuta: AfricaCeuta
- Africa/Conakry: AfricaConakry
- Africa/Dakar: AfricaDakar
- Africa/Dar_es_Salaam: AfricaDarEsSalaam
- Africa/Djibouti: AfricaDjibouti
- Africa/Douala: AfricaDouala
- Africa/El_Aaiun: AfricaElAaiun
- Africa/Freetown: AfricaFreetown
- Africa/Gaborone: AfricaGaborone
- Africa/Harare: AfricaHarare
- Africa/Johannesburg: AfricaJohannesburg
- Africa/Juba: AfricaJuba
- Africa/Kampala: AfricaKampala
- Africa/Khartoum: AfricaKhartoum
- Africa/Kigali: AfricaKigali
- Africa/Kinshasa: AfricaKinshasa
- Africa/Lagos: AfricaLagos
- Africa/Libreville: AfricaLibreville
- Africa/Lome: AfricaLome
- Africa/Luanda: AfricaLuanda
- Africa/Lubumbashi: AfricaLubumbashi
- Africa/Lusaka: AfricaLusaka
- Africa/Malabo: AfricaMalabo
- Africa/Maputo: AfricaMaputo
- Africa/Maseru: AfricaMaseru
- Africa/Mbabane: AfricaMbabane
- Africa/Mogadishu: AfricaMogadishu
- Africa/Monrovia: AfricaMonrovia
- Africa/Nairobi: AfricaNairobi
- Africa/Ndjamena: AfricaNdjamena
- Africa/Niamey: AfricaNiamey
- Africa/Nouakchott: AfricaNouakchott
- Africa/Ouagadougou: AfricaOuagadougou
- Africa/Porto-Novo: AfricaPortoNovo
- Africa/Tripoli: AfricaTripoli
- Africa/Tunis: AfricaTunis
- Africa/Windhoek: AfricaWindhoek
- America/Adak: AmericaAdak
- America/Anchorage: AmericaAnchorage
- America/Anguilla: AmericaAnguilla
- America/Antigua: AmericaAntigua
- America/Araguaina: AmericaAraguaina
- America/Argentina/Buenos_Aires: AmericaArgentinaBuenosAires
- America/Argentina/Catamarca: AmericaArgentinaCatamarca
- America/Argentina/Cordoba: AmericaArgentinaCordoba
- America/Argentina/Jujuy: AmericaArgentinaJujuy
- America/Argentina/La_Rioja: AmericaArgentinaLaRioja
- America/Argentina/Mendoza: AmericaArgentinaMendoza
- America/Argentina/Rio_Gallegos: AmericaArgentinaRioGallegos
- America/Argentina/Salta: AmericaArgentinaSalta
- America/Argentina/San_Juan: AmericaArgentinaSanJuan
- America/Argentina/San_Luis: AmericaArgentinaSanLuis
- America/Argentina/Tucuman: AmericaArgentinaTucuman
- America/Argentina/Ushuaia: AmericaArgentinaUshuaia
- America/Aruba: AmericaAruba
- America/Asuncion: AmericaAsuncion
- America/Atikokan: AmericaAtikokan
- America/Bahia: AmericaBahia
- America/Bahia_Banderas: AmericaBahiaBanderas
- America/Barbados: AmericaBarbados
- America/Belem: AmericaBelem
- America/Belize: AmericaBelize
- America/Blanc-Sablon: AmericaBlancSablon
- America/Boa_Vista: AmericaBoaVista
- America/Bogota: AmericaBogota
- America/Boise: AmericaBoise
- America/Cambridge_Bay: AmericaCambridgeBay
- America/Campo_Grande: AmericaCampoGrande
- America/Cancun: AmericaCancun
- America/Caracas: AmericaCaracas
- America/Cayenne: AmericaCayenne
- America/Cayman: AmericaCayman
- America/Chicago: AmericaChicago
- America/Chihuahua: AmericaChihuahua
- America/Ciudad_Juarez: AmericaCiudadJuarez
- America/Costa_Rica: AmericaCostaRica
- America/Creston: AmericaCreston
- America/Cuiaba: AmericaCuiaba
- America/Curacao: AmericaCuracao
- America/Danmarkshavn: AmericaDanmarkshavn
- America/Dawson: AmericaDawson
- America/Dawson_Creek: AmericaDawsonCreek
- America/Denver: AmericaDenver
- America/Detroit: AmericaDetroit
- America/Dominica: AmericaDominica
- America/Edmonton: AmericaEdmonton
- America/Eirunepe: AmericaEirunepe
- America/El_Salvador: AmericaElSalvador
- America/Fort_Nelson: AmericaFortNelson
- America/Fortaleza: AmericaFortaleza
- America/Glace_Bay: AmericaGlaceBay
- America/Goose_Bay: AmericaGooseBay
- America/Grand_Turk: AmericaGrandTurk
- America/Grenada: AmericaGrenada
- America/Guadeloupe: AmericaGuadeloupe
- America/Guatemala: AmericaGuatemala
- America/Guayaquil: AmericaGuayaquil
- America/Guyana: AmericaGuyana
- America/Halifax: AmericaHalifax
- America/Havana: AmericaHavana
- America/Hermosillo: AmericaHermosillo
- America/Indiana/Indianapolis: AmericaIndianaIndianapolis
- America/Indiana/Knox: AmericaIndianaKnox
- America/Indiana/Marengo: AmericaIndianaMarengo
- America/Indiana/Petersburg: AmericaIndianaPetersburg
- America/Indiana/Tell_City: AmericaIndianaTellCity
- America/Indiana/Vevay: AmericaIndianaVevay
- America/Indiana/Vincennes: AmericaIndianaVincennes
- America/Indiana/Winamac: AmericaIndianaWinamac
- America/Inuvik: AmericaInuvik
- America/Iqaluit: AmericaIqaluit
- America/Jamaica: AmericaJamaica
- America/Juneau: AmericaJuneau
- America/Kentucky/Louisville: AmericaKentuckyLouisville
- America/Kentucky/Monticello: AmericaKentuckyMonticello
- America/Kralendijk: AmericaKralendijk
- America/La_Paz: AmericaLaPaz
- America/Lima: AmericaLima
- America/Los_Angeles: AmericaLosAngeles
- America/Lower_Princes: AmericaLowerPrinces
- America/Maceio: AmericaMaceio
- America/Managua: AmericaManagua
- America/Manaus: AmericaManaus
- America/Marigot: AmericaMarigot
- America/Martinique: AmericaMartinique
- America/Matamoros: AmericaMatamoros
- America/Mazatlan: AmericaMazatlan
- America/Menominee: AmericaMenominee
- America/Merida: AmericaMerida
- America/Mexico_City: AmericaMexicoCity
- America/Miquelon: AmericaMiquelon
- America/Moncton: AmericaMoncton
- America/Monterrey: AmericaMonterrey
- America/Montevideo: AmericaMontevideo
- America/Montserrat: AmericaMontserrat
- America/Nassau: AmericaNassau
- America/New_York: AmericaNewYork
- America/Nome: AmericaNome
- America/Noronha: AmericaNoronha
- America/North_Dakota/Beulah: AmericaNorthDakotaBeulah
- America/North_Dakota/Center: AmericaNorthDakotaCenter
- America/North_Dakota/New_Salem: AmericaNorthDakotaNewSalem
- America/Ojinaga: AmericaOjinaga
- America/Panama: AmericaPanama
- America/Paramaribo: AmericaParamaribo
- America/Phoenix: AmericaPhoenix
- America/Port-au-Prince: AmericaPortAuPrince
- America/Port_of_Spain: AmericaPortOfSpain
- America/Porto_Velho: AmericaPortoVelho
- America/Puerto_Rico: AmericaPuertoRico
- America/Punta_Arenas: AmericaPuntaArenas
- America/Rankin_Inlet: AmericaRankinInlet
- America/Recife: AmericaRecife
- America/Regina: AmericaRegina
- America/Resolute: AmericaResolute
- America/Rio_Branco: AmericaRioBranco
- America/Santarem: AmericaSantarem
- America/Santiago: AmericaSantiago
- America/Santo_Domingo: AmericaSantoDomingo
- America/Sao_Paulo: AmericaSaoPaulo
- America/Scoresbysund: AmericaScoresbysund
- America/Sitka: AmericaSitka
- America/St_Barthelemy: AmericaStBarthelemy
- America/St_Johns: AmericaStJohns
- America/St_Kitts: AmericaStKitts
- America/St_Lucia: AmericaStLucia
- America/St_Thomas: AmericaStThomas
- America/St_Vincent: AmericaStVincent
- America/Swift_Current: AmericaSwiftCurrent
- America/Tegucigalpa: AmericaTegucigalpa
- America/Thule: AmericaThule
- America/Tijuana: AmericaTijuana
- America/Toronto: AmericaToronto
- America/Tortola: AmericaTortola
- America/Vancouver: AmericaVancouver
- America/Whitehorse: AmericaWhitehorse
- America/Winnipeg: AmericaWinnipeg
- America/Yakutat: AmericaYakutat
- Antarctica/Davis: AntarcticaDavis
- Antarctica/DumontDUrville: AntarcticaDumontDUrville
- Antarctica/Macquarie: AntarcticaMacquarie
- Antarctica/Mawson: AntarcticaMawson
- Antarctica/McMurdo: AntarcticaMcMurdo
- Antarctica/Palmer: AntarcticaPalmer
- Antarctica/Rothera: AntarcticaRothera
- Antarctica/Syowa: AntarcticaSyowa
- Arctic/Longyearbyen: ArcticLongyearbyen
- Asia/Aden: AsiaAden
- Asia/Almaty: AsiaAlmaty
- Asia/Amman: AsiaAmman
- Asia/Anadyr: AsiaAnadyr
- Asia/Aqtau: AsiaAqtau
- Asia/Aqtobe: AsiaAqtobe
- Asia/Ashgabat: AsiaAshgabat
- Asia/Atyrau: AsiaAtyrau
- Asia/Baghdad: AsiaBaghdad
- Asia/Bahrain: AsiaBahrain
- Asia/Baku: AsiaBaku
- Asia/Bangkok: AsiaBangkok
- Asia/Barnaul: AsiaBarnaul
- Asia/Beirut: AsiaBeirut
- Asia/Bishkek: AsiaBishkek
- Asia/Brunei: AsiaBrunei
- Asia/Chita: AsiaChita
- Asia/Colombo: AsiaColombo
- Asia/Damascus: AsiaDamascus
- Asia/Dhaka: AsiaDhaka
- Asia/Dili: AsiaDili
- Asia/Dubai: AsiaDubai
- Asia/Dushanbe: AsiaDushanbe
- Asia/Gaza: AsiaGaza
- Asia/Hebron: AsiaHebron
- Asia/Ho_Chi_Minh: AsiaHoChiMinh
- Asia/Hong_Kong: AsiaHongKong
- Asia/Hovd: AsiaHovd
- Asia/Irkutsk: AsiaIrkutsk
- Asia/Jakarta: AsiaJakarta
- Asia/Jayapura: AsiaJayapura
- Asia/Jerusalem: AsiaJerusalem
- Asia/Kabul: AsiaKabul
- Asia/Kamchatka: AsiaKamchatka
- Asia/Karachi: AsiaKarachi
- Asia/Kathmandu: AsiaKathmandu
- Asia/Khandyga: AsiaKhandyga
- Asia/Kolkata: AsiaKolkata
- Asia/Krasnoyarsk: AsiaKrasnoyarsk
- Asia/Kuala_Lumpur: AsiaKualaLumpur
- Asia/Kuching: AsiaKuching
- Asia/Kuwait: AsiaKuwait
- Asia/Macau: AsiaMacau
- Asia/Magadan: AsiaMagadan
- Asia/Makassar: AsiaMakassar
- Asia/Manila: AsiaManila
- Asia/Muscat: AsiaMuscat
- Asia/Nicosia: AsiaNicosia
- Asia/Novokuznetsk: AsiaNovokuznetsk
- Asia/Novosibirsk: AsiaNovosibirsk
- Asia/Omsk: AsiaOmsk
- Asia/Oral: AsiaOral
- Asia/Phnom_Penh: AsiaPhnomPenh
- Asia/Pontianak: AsiaPontianak
- Asia/Pyongyang: AsiaPyongyang
- Asia/Qatar: AsiaQatar
- Asia/Qostanay: AsiaQostanay
- Asia/Riyadh: AsiaRiyadh
- Asia/Sakhalin: AsiaSakhalin
- Asia/Samarkand: AsiaSamarkand
- Asia/Seoul: AsiaSeoul
- Asia/Shanghai: AsiaShanghai
- Asia/Singapore: AsiaSingapore
- Asia/Srednekolymsk: AsiaSrednekolymsk
- Asia/Taipei: AsiaTaipei
- Asia/Tashkent: AsiaTashkent
- Asia/Tbilisi: AsiaTbilisi
- Asia/Tehran: AsiaTehran
- Asia/Thimphu: AsiaThimphu
- Asia/Tokyo: AsiaTokyo
- Asia/Tomsk: AsiaTomsk
- Asia/Ulaanbaatar: AsiaUlaanbaatar
- Asia/Urumqi: AsiaUrumqi
- Asia/Ust-Nera: AsiaUstNera
- Asia/Vientiane: AsiaVientiane
- Asia/Vladivostok: AsiaVladivostok
- Asia/Yakutsk: AsiaYakutsk
- Asia/Yangon: AsiaYangon
- Asia/Yekaterinburg: AsiaYekaterinburg
- Asia/Yerevan: AsiaYerevan
- Atlantic/Azores: AtlanticAzores
- Atlantic/Bermuda: AtlanticBermuda
- Atlantic/Canary: AtlanticCanary
- Atlantic/Cape_Verde: AtlanticCapeVerde
- Atlantic/Faroe: AtlanticFaroe
- Atlantic/Madeira: AtlanticMadeira
- Atlantic/Reykjavik: AtlanticReykjavik
- Atlantic/South_Georgia: AtlanticSouthGeorgia
- Atlantic/St_Helena: AtlanticStHelena
- Atlantic/Stanley: AtlanticStanley
- Australia/Adelaide: AustraliaAdelaide
- Australia/Brisbane: AustraliaBrisbane
- Australia/Broken_Hill: AustraliaBrokenHill
- Australia/Darwin: AustraliaDarwin
- Australia/Eucla: AustraliaEucla
- Australia/Hobart: AustraliaHobart
- Australia/Lindeman: AustraliaLindeman
- Australia/Lord_Howe: AustraliaLordHowe
- Australia/Melbourne: AustraliaMelbourne
- Australia/Perth: AustraliaPerth
- Australia/Sydney: AustraliaSydney
- Europe/Amsterdam: EuropeAmsterdam
- Europe/Andorra: EuropeAndorra
- Europe/Astrakhan: EuropeAstrakhan
- Europe/Athens: EuropeAthens
- Europe/Belgrade: EuropeBelgrade
- Europe/Berlin: EuropeBerlin
- Europe/Bratislava: EuropeBratislava
- Europe/Brussels: EuropeBrussels
- Europe/Bucharest: EuropeBucharest
- Europe/Budapest: EuropeBudapest
- Europe/Busingen: EuropeBusingen
- Europe/Chisinau: EuropeChisinau
- Europe/Copenhagen: EuropeCopenhagen
- Europe/Dublin: EuropeDublin
- Europe/Gibraltar: EuropeGibraltar
- Europe/Guernsey: EuropeGuernsey
- Europe/Helsinki: EuropeHelsinki
- Europe/Isle_of_Man: EuropeIsleOfMan
- Europe/Istanbul: EuropeIstanbul
- Europe/Jersey: EuropeJersey
- Europe/Kaliningrad: EuropeKaliningrad
- Europe/Kirov: EuropeKirov
- Europe/Kyiv: EuropeKyiv
- Europe/Lisbon: EuropeLisbon
- Europe/Ljubljana: EuropeLjubljana
- Europe/London: EuropeLondon
- Europe/Luxembourg: EuropeLuxembourg
- Europe/Madrid: EuropeMadrid
- Europe/Malta: EuropeMalta
- Europe/Mariehamn: EuropeMariehamn
- Europe/Minsk: EuropeMinsk
- Europe/Monaco: EuropeMonaco
- Europe/Moscow: EuropeMoscow
- Europe/Oslo: EuropeOslo
- Europe/Paris: EuropeParis
- Europe/Podgorica: EuropePodgorica
- Europe/Prague: EuropePrague
- Europe/Riga: EuropeRiga
- Europe/Rome: EuropeRome
- Europe/Samara: EuropeSamara
- Europe/San_Marino: EuropeSanMarino
- Europe/Sarajevo: EuropeSarajevo
- Europe/Saratov: EuropeSaratov
- Europe/Simferopol: EuropeSimferopol
- Europe/Skopje: EuropeSkopje
- Europe/Sofia: EuropeSofia
- Europe/Stockholm: EuropeStockholm
- Europe/Tallinn: EuropeTallinn
- Europe/Tirane: EuropeTirane
- Europe/Ulyanovsk: EuropeUlyanovsk
- Europe/Vaduz: EuropeVaduz
- Europe/Vatican: EuropeVatican
- Europe/Vienna: EuropeVienna
- Europe/Vilnius: EuropeVilnius
- Europe/Volgograd: EuropeVolgograd
- Europe/Warsaw: EuropeWarsaw
- Europe/Zagreb: EuropeZagreb
- Europe/Zurich: EuropeZurich
- Indian/Antananarivo: IndianAntananarivo
- Indian/Chagos: IndianChagos
- Indian/Christmas: IndianChristmas
- Indian/Cocos: IndianCocos
- Indian/Comoro: IndianComoro
- Indian/Kerguelen: IndianKerguelen
- Indian/Mahe: IndianMahe
- Indian/Maldives: IndianMaldives
- Indian/Mauritius: IndianMauritius
- Indian/Mayotte: IndianMayotte
- Indian/Reunion: IndianReunion
- Pacific/Apia: PacificApia
- Pacific/Auckland: PacificAuckland
- Pacific/Bougainville: PacificBougainville
- Pacific/Chatham: PacificChatham
- Pacific/Chuuk: PacificChuuk
- Pacific/Easter: PacificEaster
- Pacific/Efate: PacificEfate
- Pacific/Fakaofo: PacificFakaofo
- Pacific/Fiji: PacificFiji
- Pacific/Funafuti: PacificFunafuti
- Pacific/Galapagos: PacificGalapagos
- Pacific/Gambier: PacificGambier
- Pacific/Guadalcanal: PacificGuadalcanal
- Pacific/Guam: PacificGuam
- Pacific/Honolulu: PacificHonolulu
- Pacific/Kiritimati: PacificKiritimati
- Pacific/Kosrae: PacificKosrae
- Pacific/Kwajalein: PacificKwajalein
- Pacific/Majuro: PacificMajuro
- Pacific/Marquesas: PacificMarquesas
- Pacific/Midway: PacificMidway
- Pacific/Nauru: PacificNauru
- Pacific/Niue: PacificNiue
- Pacific/Norfolk: PacificNorfolk
- Pacific/Noumea: PacificNoumea
- Pacific/Pago_Pago: PacificPagoPago
- Pacific/Palau: PacificPalau
- Pacific/Pitcairn: PacificPitcairn
- Pacific/Pohnpei: PacificPohnpei
- Pacific/Port_Moresby: PacificPortMoresby
- Pacific/Rarotonga: PacificRarotonga
- Pacific/Saipan: PacificSaipan
- Pacific/Tahiti: PacificTahiti
- Pacific/Tarawa: PacificTarawa
- Pacific/Tongatapu: PacificTongatapu
- Pacific/Wake: PacificWake
- Pacific/Wallis: PacificWallis
- UTC: Utc
Possible values:
- 1: Salary
- 2: HourlyWage
Start week on Monday?
The date after the co-worker is not allowed to edit his entries anymore. Ignored if edit_lock_period is given as well. Can only be managed by administrators or workers with elevated access manage_users_access.
Possible values:
- 1: LockDays1
- 2: LockDays2
- 3: LockDays3
- 5: LockDays5
- 8: LockDays8
- 15: LockDays15
- 31: LockDays31
- 46: LockDays46
- 91: LockDays91
Possible values:
- current_month: CurrentMonth
Can future changes to the company-wide edit lock overwrite the edit lock for this co-worker? Can only be managed by administrators or workers with elevated access manage_users_access.
Possible values:
- 0: LockDays0
- 1: LockDays1
- 2: LockDays2
- 3: LockDays3
- 5: LockDays5
- 8: LockDays8
- 15: LockDays15
- 31: LockDays31
- 46: LockDays46
- 91: LockDays91
The exit date in format YYYY-MM-DD. Must be today or later. Setting this value automatically ends the co-worker's target hours at the exit date. Pass null to clear the exit date.
Uses the company's default holiday count
Uses the company's default target hours
Uses the company's default work time regulation
Is exempt from flextime violation evaluation
Example request
{
"edit_lock": "2023-02-28",
"start_date": "2023-02-28",
"exit_date": "2035-12-31"
}Response
Successful operation
Example response
{
"data": {
"id": 10,
"future_coworker": true,
"start_date": "2024-07-15",
"exit_date": "2026-12-31",
"edit_lock": "2024-06-15",
"created_at": "2024-07-15T10:00:00Z",
"bill_service_id": "1234",
"support_pin": "1234"
}
}Changes
- info
added the new optional request property
- info
- info
added the optional property
/to the response with the status
- info