Connectors Reference

timeghost

timeghost is a dedicated Microsoft 365 / Office 365 solution that integrates perfectly with your work environment. Generate time reports, invoices and other documents using the timeghost connector.

 

Status: Preview

Tier: Premium

Version: 2.0

 

Actions:

Name

Summary

Get_Currentuser ()

Get Current User

Get_Workspace_ById (string workspace-id, string workspace_id)

Get Workspace by ID

Get_Client_Projects (string workspace-id, string clientid, [advanced][Optional]string $filter)

Get Client Projects

Get_Project_Tasks (string workspace-id, string clientid, string projectid, [advanced][Optional]string $filter)

Get Project Tasks

Get_Projects ([advanced][Optional]string $filter, string workspace-id)

Get Projects

Add_Project (string workspace-id, Project body)

Add Project

Update_Project (string workspace-id, string ProjectId, Project body)

Update Project

Get_Times (string workspace-id, string $filter-date-range, [Optional]string $filter-user, [advanced][Optional]string $filter)

Get Times

Get_Project_Times (string workspace-id, string clientid, string projectid, string $filter-date-range, [Optional]string $filter-user, [advanced][Optional]string $filter)

Get Project Times

Get_Client_Times (string workspace-id, string clientid, string $filter-date-range, [Optional]string $filter-user, [advanced][Optional]string $filter)

Get Client Times

Add_Time (string workspace-id, Time body)

Add Time

Update_Time (string TimeId, string workspace-id, Time body)

Update Time

Add_Task (string workspace-id, Task body)

Add Task

Update_Task (string workspace-id, string TaskId, Task body)

Update Task

Get_Clients ([advanced][Optional]string $filter, string workspace-id)

Get Clients

Add_Client (string workspace-id, Client body)

Add Client

Update_Client (string workspace-id, string ClientId, Client body)

Update Client

Get_Time_Tags (string workspace-id, [advanced]string $filter)

Get Time Tags

Add_Time_Tag (string workspace-id, TimeTag body)

Add Time Tag

Update_Time_Tag (string workspace-id, string TagId, TimeTag body)

Update Time Tag

Add_CustomFeedEvent (string workspace-id, CustomFeedEvent body)

Add Custom Feed Event

Update_CustomFeedEvent (string workspace-id, string EventId, CustomFeedEvent body)

Update Custom Feed Event

Delete_Item (string ItemType, string ItemId, string workspace-id)

Delete Item

Create_Excel_Report (string workspace-id, string $filter-date-range, [Optional]string $filter-user, boolean groupedByProject, [advanced][Optional]string startDate, [advanced][Optional]string endDate)

Create Times Excel Report

 

Triggers:

Name

Summary

ClientChanges (string workspace-id, ClientChangesParameterBody body)

Client Trigger

TagChanges (string workspace-id, TagChangesParameterBody body)

Tag Trigger

ProjectChanges (string workspace-id, ProjectChangesParameterBody body)

Project Trigger

TaskChanges (string workspace-id, TaskChangesParameterBody body)

Task Trigger

TimeChanges (string workspace-id, TimeChangesParameterBody body)

Time Trigger

 

Objects:

Name

Summary

Client

 

ClientChangesParameterBody

 

ClientChangesResponse

 

ClientsResponse

 

CustomFeedEvent

 

CustomFeedEventResponse

 

Delete_ItemResponse

 

Project

 

ProjectChangesParameterBody

 

ProjectChangesResponse

 

ProjectsResponse

 

TagChangesParameterBody

 

TagChangesResponse

 

TagsResponse

 

Task

 

TaskChangesParameterBody

 

TaskChangesResponse

 

TasksResponse

 

Time

 

TimeChangesParameterBody

 

TimeChangesResponse

 

TimesResponse

 

TimeTag

 

UserResponse

 

WorkspaceResponse

 

 

Actions:

Get_Currentuser

Summary: Get Current User

Description: Returns the current User.

 

Syntax:

timeghost.Get_Currentuser ()

 

Returns:

          Type:UserResponse

 

Get_Workspace_ById

Summary: Get Workspace by ID

Description: Returns the workspace

 

Syntax:

timeghost.Get_Workspace_ById (string workspace-id, string workspace_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

workspace_id

string

(Workspace)

Workspace Id

True

 

Returns:

          Type:WorkspaceResponse

 

Get_Client_Projects

Summary: Get Client Projects

Description: Get all projects of one client in one workspace.

 

Syntax:

timeghost.Get_Client_Projects (string workspace-id, string clientid, [advanced][Optional]string $filter)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

clientid

string

(Client)

Client (or Client ID)

True

Get_Clients

$filter

string

(Filter Query)

An ODATA filter query to restrict the returned projects

False

 

Returns:

          Type:array of (ProjectsResponse)

 

Get_Project_Tasks

Summary: Get Project Tasks

Description: Get all tasks of one project in one workspace.

 

Syntax:

timeghost.Get_Project_Tasks (string workspace-id, string clientid, string projectid, [advanced][Optional]string $filter)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

clientid

string

(Client)

Client (or Client ID)

True

Get_Clients

projectid

string

(Project)

Project (or Project ID)

True

Get_Client_Projects

$filter

string

(Filter Query)

An ODATA filter query to restrict the returned tasks

False

 

Returns:

          Type:array of (TasksResponse)

 

Get_Projects

Summary: Get Projects

Description: Get all projects from a workspace.

 

Syntax:

timeghost.Get_Projects ([advanced][Optional]string $filter, string workspace-id)

 

Parameters:

Name

Type

Summary

Required

Related Action

$filter

string

(Filter Query)

An ODATA filter query to restrict the returned projects

False

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

 

Returns:

          Type:array of (ProjectsResponse)

 

Add_Project

Summary: Add Project

Description: Add a project to a workspace.

 

Syntax:

timeghost.Add_Project (string workspace-id, Project body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

body

Project

 

 

True

 

Returns:

          Type:ProjectsResponse

 

Update_Project

Summary: Update Project

Description: Update a project in a workspace.

 

Syntax:

timeghost.Update_Project (string workspace-id, string ProjectId, Project body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

ProjectId

string

(Project)

Project (or Project ID)

True

Get_Projects

body

Project

 

 

True

 

Returns:

          Type:ProjectsResponse

 

Get_Times

Summary: Get Times

Description: Get all times from a workspace.

 

Syntax:

timeghost.Get_Times (string workspace-id, string $filter-date-range, [Optional]string $filter-user, [advanced][Optional]string $filter)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

$filter-date-range

string

(Date range)Values: [today, yesterday, this_week, last_week, this_month, last_month, this_year, last_year, all_time]

Filter times by range

True

$filter-user

string

(Filter by User)

Filter the times by user

False

Get_Workspace_ById

$filter

string

(Filter Query)

An ODATA filter query to restrict the returned times

False

 

Returns:

          Type:array of (TimesResponse)

 

Get_Project_Times

Summary: Get Project Times

Description: Get all times of one project in one workspace.

 

Syntax:

timeghost.Get_Project_Times (string workspace-id, string clientid, string projectid, string $filter-date-range, [Optional]string $filter-user, [advanced][Optional]string $filter)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

clientid

string

(Client)

Client (or Client ID)

True

Get_Clients

projectid

string

(Project)

Project (or Project ID)

True

Get_Client_Projects

$filter-date-range

string

(Date range)Values: [today, yesterday, this_week, last_week, this_month, last_month, this_year, last_year, all_time]

Filter times by range

True

$filter-user

string

(Filter by User)

Filter the times by user

False

Get_Workspace_ById

$filter

string

(Filter Query)

An ODATA filter query to restrict the returned times

False

 

Returns:

          Type:array of (TasksResponse)

 

Get_Client_Times

Summary: Get Client Times

Description: Get all times of one client in one workspace.

 

Syntax:

timeghost.Get_Client_Times (string workspace-id, string clientid, string $filter-date-range, [Optional]string $filter-user, [advanced][Optional]string $filter)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

clientid

string

(Client)

Client (or Client ID)

True

Get_Clients

$filter-date-range

string

(Date range)Values: [today, yesterday, this_week, last_week, this_month, last_month, this_year, last_year, all_time]

Filter times by range

True

$filter-user

string

(Filter by User)

Filter the times by user

False

Get_Workspace_ById

$filter

string

(Filter Query)

An ODATA filter query to restrict the returned times

False

 

Returns:

          Type:array of (TasksResponse)

 

Add_Time

Summary: Add Time

Description: Add a time to a project within a workspace.

 

Syntax:

timeghost.Add_Time (string workspace-id, Time body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

body

Time

 

 

True

 

Returns:

          Type:TimesResponse

 

Update_Time

Summary: Update Time

Description: Update a time in a workspace.

 

Syntax:

timeghost.Update_Time (string TimeId, string workspace-id, Time body)

 

Parameters:

Name

Type

Summary

Required

Related Action

TimeId

string

(Time ID)

Unique ID of time to be updated

True

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

body

Time

 

 

True

 

Returns:

          Type:TimesResponse

 

Add_Task

Summary: Add Task

Description: Add a task to a workspace.

 

Syntax:

timeghost.Add_Task (string workspace-id, Task body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

body

Task

 

 

True

 

Returns:

          Type:TasksResponse

 

Update_Task

Summary: Update Task

Description: Update a task in a workspace.

 

Syntax:

timeghost.Update_Task (string workspace-id, string TaskId, Task body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

TaskId

string

(Task ID)

Unique ID of the task

True

body

Task

 

 

True

 

Returns:

          Type:TasksResponse

 

Get_Clients

Summary: Get Clients

Description: Get all clients from a workspace.

 

Syntax:

timeghost.Get_Clients ([advanced][Optional]string $filter, string workspace-id)

 

Parameters:

Name

Type

Summary

Required

Related Action

$filter

string

(Filter Query)

An ODATA filter query to restrict the returned clients

False

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

 

Returns:

          Type:array of (ClientsResponse)

 

Add_Client

Summary: Add Client

Description: Add a client to a workspace.

 

Syntax:

timeghost.Add_Client (string workspace-id, Client body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

body

Client

 

 

True

 

Returns:

          Type:ClientsResponse

 

Update_Client

Summary: Update Client

Description: Update a client in a workspace.

 

Syntax:

timeghost.Update_Client (string workspace-id, string ClientId, Client body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

ClientId

string

(Client)

Client (or Client ID)

True

Get_Clients

body

Client

 

 

True

 

Returns:

          Type:ClientsResponse

 

Get_Time_Tags

Summary: Get Time Tags

Description: Get all time tags from a workspace.

 

Syntax:

timeghost.Get_Time_Tags (string workspace-id, [advanced]string $filter)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

$filter

string

(Filter Query)Values: [tagType eq 1]

An ODATA filter query to restrict the returned projects

True

 

Returns:

          Type:array of (TagsResponse)

 

Add_Time_Tag

Summary: Add Time Tag

Description: Add a time tag to a workspace.

 

Syntax:

timeghost.Add_Time_Tag (string workspace-id, TimeTag body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

body

TimeTag

 

 

True

 

Returns:

          Type:array of (TagsResponse)

 

Update_Time_Tag

Summary: Update Time Tag

Description: Update a time tag in a workspace.

 

Syntax:

timeghost.Update_Time_Tag (string workspace-id, string TagId, TimeTag body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

TagId

string

(Tag)

Tag (or Tag ID)

True

Get_Time_Tags

body

TimeTag

 

 

True

 

Returns:

          Type:array of (TagsResponse)

 

Add_CustomFeedEvent

Summary: Add Custom Feed Event

Description: Add an event to the users feed. Entry is automatically deleted after 180 days.

 

Syntax:

timeghost.Add_CustomFeedEvent (string workspace-id, CustomFeedEvent body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

body

CustomFeedEvent

 

 

True

 

Returns:

          Type:CustomFeedEventResponse

 

Update_CustomFeedEvent

Summary: Update Custom Feed Event

Description: Update a custom feed entry in a workspace.

 

Syntax:

timeghost.Update_CustomFeedEvent (string workspace-id, string EventId, CustomFeedEvent body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

EventId

string

(ID)

Custom Feed Event ID

True

body

CustomFeedEvent

 

 

True

 

Returns:

          Type:CustomFeedEventResponse

 

Delete_Item

Summary: Delete Item

Description: Delete an item from a workspace.

 

Syntax:

timeghost.Delete_Item (string ItemType, string ItemId, string workspace-id)

 

Parameters:

Name

Type

Summary

Required

Related Action

ItemType

string

(Item Type)Values: [projects, tasks, times, clients, tags, customfeedevent]

Type of item that will be deleted

True

ItemId

string

(Item ID)

ID of the item that will be deleted

True

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

 

Returns:

          Type:Delete_ItemResponse

 

Create_Excel_Report

Summary: Create Times Excel Report

Description: Returns an Excel file containing a report of the specified time.

 

Syntax:

timeghost.Create_Excel_Report (string workspace-id, string $filter-date-range, [Optional]string $filter-user, boolean groupedByProject, [advanced][Optional]string startDate, [advanced][Optional]string endDate)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

$filter-date-range

string

(Date range)Values: [today, yesterday, this_week, last_week, this_month, last_month, this_year, last_year]

Filter times by range

True

$filter-user

string

(Filter by User)

Filter the times by user

False

Get_Workspace_ById

groupedByProject

boolean

(Grouped by Project)

Project times are divided into workbooks

True

startDate

string

(Start Date)

Start date for Excel report (overwrites date range) format: yyyy-MM-ddTHH:mm:ss.SSSZ

False

endDate

string

(End Date)

End date for Excel report (overwrites date range) format: yyyy-MM-ddTHH:mm:ss.SSSZ

False

 

Returns:

          Type:string

          Summary: Excel file

          Description: Excel file

 

Triggers:

Trigger ClientChanges

Summary: Client Trigger

Description: If a client is created, changed or deleted in timeghost, this trigger runs.

 

Syntax:

timeghost.ClientChanges (string workspace-id, ClientChangesParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

body

ClientChangesParameterBody

 

 

True

 

Returns:

          Type:ClientChangesResponse

 

Trigger TagChanges

Summary: Tag Trigger

Description: If a tag is created, changed or deleted in timeghost, this trigger runs.

 

Syntax:

timeghost.TagChanges (string workspace-id, TagChangesParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

body

TagChangesParameterBody

 

 

True

 

Returns:

          Type:TagChangesResponse

 

Trigger ProjectChanges

Summary: Project Trigger

Description: If a project is created, changed or deleted in timeghost, this trigger runs.

 

Syntax:

timeghost.ProjectChanges (string workspace-id, ProjectChangesParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

body

ProjectChangesParameterBody

 

 

True

 

Returns:

          Type:ProjectChangesResponse

 

Trigger TaskChanges

Summary: Task Trigger

Description: If a task is created, changed or deleted in timeghost, this trigger runs.

 

Syntax:

timeghost.TaskChanges (string workspace-id, TaskChangesParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

body

TaskChangesParameterBody

 

 

True

 

Returns:

          Type:TaskChangesResponse

 

Trigger TimeChanges

Summary: Time Trigger

Description: If a time is created, changed or deleted in timeghost, this trigger runs.

 

Syntax:

timeghost.TimeChanges (string workspace-id, TimeChangesParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace-id

string

(Workspace)

Enter the workspace in which your data is stored

True

Get_Currentuser

body

TimeChangesParameterBody

 

 

True

 

Returns:

          Type:TimeChangesResponse

 


 

Client

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Clients' name

description

string

Description

Description of the client


 

ClientChangesParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

The name of the webhook so that it can be found in the settings in timeghost.

entity

string

 

entity

events

array of (string)

Run on

Select the events to listen to

active

boolean

 

active  Values: [, ]

config

Config

 

config

 

Config

Summary:

Description: config

 

          Properties:

Name

Type

Summary

url

string

 

url

basicAuth

BasicAuth

 

basicAuth

 

BasicAuth

Summary:

Description: basicAuth

 

          Properties:

Name

Type

Summary

userName

string

 

userName

pass

string

 

pass

 


 

ClientChangesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ClientsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

ID

Unique ID of the client

deleted

boolean

Deleted

Indicates whether the client is marked as deleted

name

string

Name

Clients' name

description

string

Description

Description of the client

created

string(date-time)

Created

Indicates when the client was created

modified

string(date-time)

Modified

Indicates when the client was changed

status

string

Status

Indicates whether the data record was just created, updated or deleted


 

CustomFeedEvent

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Entries' name

description

string

Description

Entries' description

user

User

 

 

start

string(date-time)

Start

The start-date and start-time of the feed entry

end

string(date-time)

End

The end-date and end-time of the feed entry

imageUrl

string

Icon Url

An icon Url, which is displayed in the feed entry. Best use 96px96px and https.

url

string

Url

Url to an external address. E.g. a detail page. This link in the feed can be opened via the context menu.

category

string

Category

Use a value that can be filtered later in the interface. For example 'Planner'.

 

User

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

ID

User (or User ID)

 


 

CustomFeedEventResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

ID

Unique ID of the custom feed event

deleted

boolean

Deleted

Indicates whether the custom feed event is marked as deleted

created

string(date-time)

Created

Indicates when the custom feed event was created

modified

string(date-time)

Modified

Indicates when the custom feed event was changed

status

string

Status

Indicates whether the data record was just created, updated or deleted

name

string

Name

Custom Feed Events' name

description

string

Description

Entries' description

start

string(date-time)

Start

The start-date and start-time of the feed entry

end

string(date-time)

End

The end-date and end-time of the feed entry

imageUrl

string

Icon Url

An icon Url, which is displayed in the feed entry. Best use 96px96px and https.

url

string

Url

Url to an external address. E.g. a detail page. This link in the feed can be opened via the context menu.

category

string

Category

This value can be used to filter the feeds in the interface.


 

Delete_ItemResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Project

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Projects' name

description

string

Description

Description of the project

client

Client

 

The client of this project

color

string

Color

Color of the project eg. '#0000FF'

billable

boolean

Billable

Indicates whether the project is marked as billable

completed

boolean

Completed

Indicates whether the project is marked as completed

taskBasedEstimation

boolean

Task based estimation

The budget is task-dependent.

estimation

number(double)

Estimation

The estimated budget of the project

users

array of (UsersItem)

 

 

 

Client

Summary:

Description: The client of this project

 

          Properties:

Name

Type

Summary

id

string

ID

Client (or Client ID)

 

UsersItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

ID

User (or User ID)

 


 

ProjectChangesParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

The name of the webhook so that it can be found in the settings in timeghost.

events

array of (string)

Run on

Select the events to listen to

entity

string

 

entity

active

boolean

 

active  Values: [, ]

config

Config

 

config

 

Config

Summary:

Description: config

 

          Properties:

Name

Type

Summary

url

string

 

url

basicAuth

BasicAuth

 

basicAuth

 

BasicAuth

Summary:

Description: basicAuth

 

          Properties:

Name

Type

Summary

userName

string

 

userName

pass

string

 

pass

 


 

ProjectChangesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ProjectsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

ID

Unique ID of the project

deleted

boolean

Deleted

Indicates whether the project is marked as deleted

created

string(date-time)

Created

Indicates when the project was created

modified

string(date-time)

Modified

Indicates when the project was changed

status

string

Status

Indicates whether the data record was just created, updated or deleted

name

string

Name

Projects' name

client

Client

 

 

description

string

Description

Description of the project

color

string

Color

Color of the project. eg '#0000FF'

billable

boolean

Billable

Indicates whether the project is marked as billable

completed

boolean

Completed

Indicates whether the project is marked as completed

estimation

number(double)

Estimation

The estimated budget of the project

taskBasedEstimation

boolean

Task Based Estimation

The budget is task-dependent.

users

array of (UsersItem)

Users

Users of the project

 

Client

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

ID

Unique ID of the client of this project

name

string

Clients' name

Clients' name

 

UsersItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

User ID

Unique ID of the user of this project

name

string

Users' name

Users' name

 


 

TagChangesParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

The name of the webhook so that it can be found in the settings in timeghost.

events

array of (string)

Run on

Select the events to listen to

entity

string

 

entity

active

boolean

 

active  Values: [, ]

config

Config

 

config

 

Config

Summary:

Description: config

 

          Properties:

Name

Type

Summary

url

string

 

url

basicAuth

BasicAuth

 

basicAuth

 

BasicAuth

Summary:

Description: basicAuth

 

          Properties:

Name

Type

Summary

userName

string

 

userName

pass

string

 

pass

 


 

TagChangesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TagsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

ID

Unique ID of the tag

deleted

boolean

Deleted

Indicates whether the tag is marked as deleted

created

string(date-time)

Created

Indicates when the tag was created

modified

string(date-time)

Modified

Indicates when the tag was changed

status

string

Status

Indicates whether the data record was just created, updated or deleted

name

string

Name

Tags' name


 

Task

Summary:

Description:

 

          Properties:

Name

Type

Summary

client

Client

 

The client of this task

project

Project

 

The projet of this task

name

string

Name

Tasks' name

estimation

number(double)

Estimation (hours)

The estimated budget of the task

 

Client

Summary:

Description: The client of this task

 

          Properties:

Name

Type

Summary

id

string

ID

Client (or Client ID)

 

Project

Summary:

Description: The projet of this task

 

          Properties:

Name

Type

Summary

id

string

ID

Project (or Project ID)

 


 

TaskChangesParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

The name of the webhook so that it can be found in the settings in timeghost.

events

array of (string)

Run on

Select the events to listen to

entity

string

 

entity

active

boolean

 

active  Values: [, ]

config

Config

 

config

 

Config

Summary:

Description: config

 

          Properties:

Name

Type

Summary

url

string

 

url

basicAuth

BasicAuth

 

basicAuth

 

BasicAuth

Summary:

Description: basicAuth

 

          Properties:

Name

Type

Summary

userName

string

 

userName

pass

string

 

pass

 


 

TaskChangesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TasksResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

ID

Unique ID of the task

deleted

boolean

Deleted

Indicates whether the task is marked as deleted

created

string(date-time)

Created

Indicates when the task was created

modified

string(date-time)

Modified

Indicates when the task was changed

status

string

Status

Indicates whether the data record was just created, updated or deleted

name

string

Name

Tasks' Name

client

Client

 

 

project

Project

 

 

estimation

number(double)

Estimation

The estimated budget of the task

 

Client

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Client ID

Unique ID of the client of this task

name

string

Clients' Name

Clients' Name

 

Project

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Project ID

Unique ID of the project of this task

name

string

Projects' name

Projects' name

 


 

Time

Summary:

Description:

 

          Properties:

Name

Type

Summary

client

Client

 

The client of this time

project

Project

 

The projet of this time

name

string

Name

The name of this time entry (task name)

start

string(date-time)

Start

The start-date and start-time of the time entry

end

string(date-time)

End

The end-date and end-time of the time entry

billable

boolean

Billable

Indicates whether the time is marked as billable

tags

array of (TagsItem)

Tags

 

 

Client

Summary:

Description: The client of this time

 

          Properties:

Name

Type

Summary

id

string

ID

Client (or Client ID)

 

Project

Summary:

Description: The projet of this time

 

          Properties:

Name

Type

Summary

id

string

ID

Project (or Project ID)

 

TagsItem

Summary:

Description: The tag of this time

 

          Properties:

Name

Type

Summary

id

string

ID

Tag (or Tag ID)

 


 

TimeChangesParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

The name of the webhook so that it can be found in the settings in timeghost.

events

array of (string)

Run on

Select the events to listen to

entity

string

 

entity

active

boolean

 

active  Values: [, ]

config

Config

 

config

 

Config

Summary:

Description: config

 

          Properties:

Name

Type

Summary

url

string

 

url

basicAuth

BasicAuth

 

basicAuth

 

BasicAuth

Summary:

Description: basicAuth

 

          Properties:

Name

Type

Summary

userName

string

 

userName

pass

string

 

pass

 


 

TimeChangesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TimesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

ID

Unique ID of the time

deleted

boolean

Deleted

Indicates whether the time is marked as deleted

billable

boolean

Billable

Indicates whether the time is marked as billable

client

Client

 

 

project

Project

 

 

task

Task

 

 

user

User

 

 

timeDiff

number

Duration

The duration of the time entry

start

string(date-time)

Start

The start-date and start-time of the time entry

end

string(date-time)

End

The end-date and end-time of the time entry

tags

array of (TagsItem)

 

 

created

string(date-time)

Created

Indicates when the time was created

modified

string(date-time)

Modified

Indicates when the time was changed

status

string

Status

Indicates whether the data record was just created, updated or deleted

 

Client

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Client ID

Unique ID of the client of this time

name

string

Clients' name

Clients' name

 

Project

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Project ID

Unique ID of the project of this time

name

string

Projects' name

Projects' name

 

Task

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Task ID

Unique ID of the task of this time

name

string

Tasks' name

Tasks' name

 

User

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

User ID

Unique ID of the user of this time

name

string

Users' name

Users' name

 

TagsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Tag ID

Unique ID of the tag of this time

name

string

Tags' name

Tags' name

 


 

TimeTag

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Tags' name

tagType

integer(int32)

Name

tagType  Values: []


 

UserResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

ID

Unique ID of the user

deleted

boolean

Deleted

Indicates whether the tag is marked as deleted

email

string

E-Mail

User's email adress

defaultWorkspace

string

Default workspace ID

The workspace Id of the default workspace of the user

workspaces

array of (WorkspacesItem)

 

 

 

WorkspacesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Workspace ID

Unique ID of the workspace

name

string

Workspace-Name

Workspace-Name

 


 

WorkspaceResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

ID

Unique ID of the user

name

string

Name

Workspace name

users

array of (UsersItem)

 

 

 

UsersItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

User ID

Unique ID of the user

name

string

Name

User-Name

email

string

E-Mail

Users' email