User

Changed on
get/v3/users

Request

  • Base URL
    https://my.clockodo.com/api
  • URL
    https://my.clockodo.com/api/v3/users
  • 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 2
      Authorization code: /oauth/authorize
      Token URL: /token

Query parameters

activeboolean
fulltextstring
items_per_pageinteger
Example:100
pageinteger
Example:1
scope'manageAbsences' | 'viewAbsences' | 'viewUserReports' | 'viewUserReportsDetailed' | 'viewPresences'

Possible values:

  • manageAbsences: ManageAbsences
  • viewAbsences: ViewAbsences
  • viewUserReports: ViewUserReports
  • viewUserReportsDetailed: ViewUserReportsDetailed
  • viewPresences: ViewPresences
ApiUsersV3SortForIndex[]
OR
'active' | '-active' | 'id' | '-id' | 'name' | '-name' | 'number' | '-number' | 'role' | '-role' | 'teams_name' | '-teams_name'

Possible values:

  • active: ActiveAsc
  • -active: ActiveDesc
  • id: IdAsc
  • -id: IdDesc
  • name: NameAsc
  • -name: NameDesc
  • number: NumberAsc
  • -number: NumberDesc
  • role: RoleAsc
  • -role: RoleDesc
  • teams_name: TeamsNameAsc
  • -teams_name: TeamsNameDesc
OR
string csv-string

Response

Successful operation

Example response

{
  "paging": {
    "items_per_page": 1000,
    "current_page": 1,
    "count_pages": 1,
    "count_items": 4
  },
  "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