API

Every clockify.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.

Projects

list

projects.list List projects in a workspace Risk: read

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

Input

Name	Type	Required	Description
`workspaceId`	`string`	Yes	—
`page`	`number`	No	—
`pageSize`	`number`	No	—

Output: object[]

Output full type

{
  id: string,
  name: string,
  workspaceId: string
}[]

Tasks

list

tasks.list List tasks for a project in a workspace Risk: read

await corsair.clockify.api.tasks.list({});

Input

Name	Type	Required	Description
`workspaceId`	`string`	Yes	—
`projectId`	`string`	Yes	—
`page`	`number`	No	—
`pageSize`	`number`	No	—

Output: object[]

Output full type

{
  id: string,
  name: string,
  projectId: string
}[]

Time Entries

create

timeEntries.create Create a new time entry Risk: write

await corsair.clockify.api.timeEntries.create({});

Input

Name	Type	Required	Description
`workspaceId`	`string`	Yes	—
`description`	`string`	Yes	—
`start`	`string`	Yes	—
`end`	`string`	No	—
`projectId`	`string`	No	—
`taskId`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`description`	`string`	Yes	—
`workspaceId`	`string`	Yes	—
`projectId`	`string`	No	—
`taskId`	`string`	No	—
`timeInterval`	`object`	No	—

timeInterval full type

{
  start: string,
  end?: string | null,
  duration?: string | null
}

list

timeEntries.list List time entries for a user in a workspace Risk: read

await corsair.clockify.api.timeEntries.list({});

Input

Name	Type	Required	Description
`workspaceId`	`string`	Yes	—
`userId`	`string`	Yes	—
`description`	`string`	No	—
`project`	`string`	No	—
`page`	`number`	No	—
`pageSize`	`number`	No	—

Output: object[]

Output full type

{
  id: string,
  description: string,
  workspaceId: string,
  projectId?: string | null,
  taskId?: string | null,
  timeInterval?: {
    start: string,
    end?: string | null,
    duration?: string | null
  } | null
}[]

Workspaces

list

workspaces.list List all workspaces Risk: read

await corsair.clockify.api.workspaces.list({});

Input: empty object Output: object[]

Output full type

{
  id: string,
  name: string
}[]

Overview

Plugins

Projects

list

Tasks

list

Time Entries

create

list

Workspaces

list

​Projects

​list

​Tasks

​list

​Time Entries

​create

​list

​Workspaces

​list

Projects

list

Tasks

list

Time Entries

create

list

Workspaces

list