API

Every desktime.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Company

get

company.get Read the account’s name, work hours, tracking window and timezone Risk: read

await corsair.desktime.api.company.get({});

Input: empty object Output

Name	Type	Required	Description
`name`	`string \| null`	No	—
`work_starts`	`string \| null`	No	—
`work_ends`	`string \| null`	No	—
`work_duration`	`string \| number \| null`	No	—
`working_days`	`number \| null`	No	—
`work_start_tracking`	`string \| null`	No	—
`work_stop_tracking`	`string \| null`	No	—
`timezone_identifier`	`string \| null`	No	—
`__request_time`	`string \| null`	No	—

Employee

apps

employee.apps Read the apps one employee used on a day, grouped as unrated, neutral and productive Risk: read

await corsair.desktime.api.employee.apps({ id: 789760 });

Input

Name	Type	Required	Description
`id`	`number`	No	The employee to read. Omit it to read the key owner, which is the account the API key belongs to.
`date`	`string`	No	A day in YYYY-MM-DD form.

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string \| null`	No	—
`email`	`string \| null`	No	—
`groupId`	`number \| null`	No	—
`group`	`string \| null`	No	—
`profileUrl`	`string \| null`	No	—
`isOnline`	`boolean \| null`	No	—
`arrived`	`string \| false \| null`	No	A timestamp, or `false` when it has not happened yet.
`left`	`string \| false \| null`	No	A timestamp, or `false` when it has not happened yet.
`late`	`boolean \| null`	No	—
`onlineTime`	`number \| null`	No	—
`offlineTime`	`number \| null`	No	—
`desktimeTime`	`number \| null`	No	—
`atWorkTime`	`number \| null`	No	—
`afterWorkTime`	`number \| null`	No	—
`beforeWorkTime`	`number \| null`	No	—
`productiveTime`	`number \| null`	No	—
`productivity`	`number \| null`	No	—
`efficiency`	`number \| null`	No	—
`work_starts`	`string \| false \| null`	No	A timestamp, or `false` when it has not happened yet.
`work_ends`	`string \| false \| null`	No	A timestamp, or `false` when it has not happened yet.
`notes`	`Record<string, any>[] \| null`	No	—
`timezone`	`string \| null`	No	—
`activeProject`	`object[] \| object \| null`	No	—
`apps`	`object \| null`	No	Tracked apps keyed by productivity class, where `-1` is unrated, `0` neutral and `1` productive.
`apps_by_productivity`	`object`	No	The same apps relabelled from the numeric productivity keys to `unrated`, `neutral` and `productive`.

activeProject full type

{
  project?: string | null,
  task?: string | null
}[] | {
  project?: string | null,
  task?: string | null
} | null

apps full type

Record<string, {
  app?: string | null,
  title?: string | null,
  time?: number | null
}[]> | null

apps_by_productivity full type

{
  unrated?: {
    app?: string | null,
    title?: string | null,
    time?: number | null
  }[],
  neutral?: {
    app?: string | null,
    title?: string | null,
    time?: number | null
  }[],
  productive?: {
    app?: string | null,
    title?: string | null,
    time?: number | null
  }[]
}

basic

employee.basic Read one employee’s arrival, departure, tracked time and productivity for a day, defaulting to the key owner and today Risk: read

await corsair.desktime.api.employee.basic({ id: 789760, date: '2026-11-08' });

Input

Name	Type	Required	Description
`id`	`number`	No	The employee to read. Omit it to read the key owner, which is the account the API key belongs to.
`date`	`string`	No	A day in YYYY-MM-DD form.

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string \| null`	No	—
`email`	`string \| null`	No	—
`groupId`	`number \| null`	No	—
`group`	`string \| null`	No	—
`profileUrl`	`string \| null`	No	—
`isOnline`	`boolean \| null`	No	—
`arrived`	`string \| false \| null`	No	A timestamp, or `false` when it has not happened yet.
`left`	`string \| false \| null`	No	A timestamp, or `false` when it has not happened yet.
`late`	`boolean \| null`	No	—
`onlineTime`	`number \| null`	No	—
`offlineTime`	`number \| null`	No	—
`desktimeTime`	`number \| null`	No	—
`atWorkTime`	`number \| null`	No	—
`afterWorkTime`	`number \| null`	No	—
`beforeWorkTime`	`number \| null`	No	—
`productiveTime`	`number \| null`	No	—
`productivity`	`number \| null`	No	—
`efficiency`	`number \| null`	No	—
`work_starts`	`string \| false \| null`	No	A timestamp, or `false` when it has not happened yet.
`work_ends`	`string \| false \| null`	No	A timestamp, or `false` when it has not happened yet.
`notes`	`Record<string, any>[] \| null`	No	—
`timezone`	`string \| null`	No	—
`activeProject`	`object[] \| object \| null`	No	—

activeProject full type

{
  project?: string | null,
  task?: string | null
}[] | {
  project?: string | null,
  task?: string | null
} | null

projects

employee.projects Read the projects one employee tracked time against on a day Risk: read

await corsair.desktime.api.employee.projects({ id: 789760, date: '2026-11-08' });

Input

Name	Type	Required	Description
`id`	`number`	No	The employee to read. Omit it to read the key owner, which is the account the API key belongs to.
`date`	`string`	No	A day in YYYY-MM-DD form.

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string \| null`	No	—
`email`	`string \| null`	No	—
`groupId`	`number \| null`	No	—
`group`	`string \| null`	No	—
`profileUrl`	`string \| null`	No	—
`isOnline`	`boolean \| null`	No	—
`arrived`	`string \| false \| null`	No	A timestamp, or `false` when it has not happened yet.
`left`	`string \| false \| null`	No	A timestamp, or `false` when it has not happened yet.
`late`	`boolean \| null`	No	—
`onlineTime`	`number \| null`	No	—
`offlineTime`	`number \| null`	No	—
`desktimeTime`	`number \| null`	No	—
`atWorkTime`	`number \| null`	No	—
`afterWorkTime`	`number \| null`	No	—
`beforeWorkTime`	`number \| null`	No	—
`productiveTime`	`number \| null`	No	—
`productivity`	`number \| null`	No	—
`efficiency`	`number \| null`	No	—
`work_starts`	`string \| false \| null`	No	A timestamp, or `false` when it has not happened yet.
`work_ends`	`string \| false \| null`	No	A timestamp, or `false` when it has not happened yet.
`notes`	`Record<string, any>[] \| null`	No	—
`timezone`	`string \| null`	No	—
`activeProject`	`object[] \| object \| null`	No	—
`projects`	`object[] \| null`	No	—

activeProject full type

{
  project?: string | null,
  task?: string | null
}[] | {
  project?: string | null,
  task?: string | null
} | null

projects full type

{
  project?: string | null,
  task?: string | null,
  time?: number | null
}[] | null

Employees

list

employees.list List every employee for a day, week or month with their arrival, tracked time and productivity, nested by date then employee id Risk: read

await corsair.desktime.api.employees.list({ date: '2026-11-02', period: 'week' });

Input

Name	Type	Required	Description
`date`	`string`	No	A day in YYYY-MM-DD form.
`period`	`day \| week \| month`	No	The window to return, starting at `date` or today. `day` returns one bucket, `week` seven, `month` the calendar month.

Output

Name	Type	Required	Description
`employees`	`object`	Yes	—
`buckets`	`object[]`	Yes	The same employees flattened out of the two-level map, newest date first, with the date kept on each entry so a multi-day response stays unambiguous.
`__request_time`	`string \| null`	No	—

employees full type

Record<string, Record<string, {
  id: number,
  name?: string | null,
  email?: string | null,
  groupId?: number | null,
  group?: string | null,
  profileUrl?: string | null,
  isOnline?: boolean | null,
  arrived?: string | false | null,
  left?: string | false | null,
  late?: boolean | null,
  onlineTime?: number | null,
  offlineTime?: number | null,
  desktimeTime?: number | null,
  atWorkTime?: number | null,
  afterWorkTime?: number | null,
  beforeWorkTime?: number | null,
  productiveTime?: number | null,
  productivity?: number | null,
  efficiency?: number | null,
  work_starts?: string | false | null,
  work_ends?: string | false | null,
  notes?: Record<string, any>[] | null,
  timezone?: string | null,
  activeProject?: {
    project?: string | null,
    task?: string | null
  }[] | {
    project?: string | null,
    task?: string | null
  } | null
}>>

buckets full type

{
  date: string,
  employees: {
    id: number,
    name?: string | null,
    email?: string | null,
    groupId?: number | null,
    group?: string | null,
    profileUrl?: string | null,
    isOnline?: boolean | null,
    arrived?: string | false | null,
    left?: string | false | null,
    late?: boolean | null,
    onlineTime?: number | null,
    offlineTime?: number | null,
    desktimeTime?: number | null,
    atWorkTime?: number | null,
    afterWorkTime?: number | null,
    beforeWorkTime?: number | null,
    productiveTime?: number | null,
    productivity?: number | null,
    efficiency?: number | null,
    work_starts?: string | false | null,
    work_ends?: string | false | null,
    notes?: Record<string, any>[] | null,
    timezone?: string | null,
    activeProject?: {
      project?: string | null,
      task?: string | null
    }[] | {
      project?: string | null,
      task?: string | null
    } | null
  }[]
}[]

Ping

get

ping.get Check that the DeskTime API answers. A configured key is still required, because the runtime resolves the account key before any endpoint runs Risk: read

await corsair.desktime.api.ping.get({});

Input: empty object Output

Name	Type	Required	Description
`pong`	`string`	Yes	—
`__request_time`	`string \| null`	No	—

Projects

list

projects.list List the account’s active projects with their tasks. Archived projects are left out Risk: read

await corsair.desktime.api.projects.list({});

Input: empty object Output

Name	Type	Required	Description
`projects`	`object[]`	Yes	—
`__request_time`	`string \| null`	No	—

projects full type

{
  id?: number | null,
  name?: string | null,
  created_at?: string | number | null,
  created_at_iso?: string | null,
  tasks?: {
    id?: number | null,
    name?: string | null,
    created_at?: string | number | null,
    created_at_iso?: string | null
  }[] | null
}[]

Overview

Plugins

Company

get

Employee

apps

basic

projects

Employees

list

Ping

get

Projects

list

​Company

​get

​Employee

​apps

​basic

​projects

​Employees

​list

​Ping

​get

​Projects

​list

Company

get

Employee

apps

basic

projects

Employees

list

Ping

get

Projects

list