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.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | timeghost Support |
| URL | https://support.timeghost.io |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Koellisch Gesellschaft für Prozessmanagement mbH |
| Website | https://timeghost.io |
| Privacy policy | https://timeghost.io/privacy-policy/ |
| Categories | Productivity;Business Intelligence |
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 Flow Connector.
Pre-requisites
To use this connector, you need to have a work, school or Microsoft personal account. You also need to accept the permissions and consent of timeghost by taking one of these two steps:
- Teams: Install the timeghost Teams app and start it, accept the permissions and consent.
- Web: Open the timeghost web app and accept the permissions and consent.
You're now ready to start using this connector.
How to get credentials?
The credentials that you need in order to use the timeghost Power Automate connector are your Office / Microsoft 365 login details. There are no additional credentials needed.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add Client |
Add a client to a workspace. |
| Add Custom Feed Event |
Add an event to the users feed. Entry is automatically deleted after 180 days. |
| Add Group |
Add a group to a workspace. |
| Add Project |
Add a project to a workspace. |
| Add Project Tag |
Add a project tag to a workspace. |
| Add Task |
Add a task to a workspace. |
| Add Time |
Add a time to a project within a workspace. |
| Add Time Tag |
Add a time tag to a workspace. |
| Create Times Excel Report |
Returns an Excel file containing a report of the specified time. |
| Delete Item |
Delete an item from a workspace. |
| Get Client Projects |
Get all projects of one client in one workspace. |
| Get Client Times |
Get all times of one client in one workspace. |
| Get Clients |
Get all clients from a workspace. |
| Get Current User |
Returns the current user object with workspaces |
| Get Project Tags |
Get all project tags from a workspace. |
| Get Project Tasks |
Get all tasks of one project in one workspace. |
| Get Project Times |
Get all times of one project in one workspace. |
| Get Projects |
Get all projects from a workspace. |
| Get Time Tags |
Get all time tags from a workspace. |
| Get Times |
Get all times from a workspace. |
| Get Workspace by ID |
Returns the workspace |
| Get Workspace Groups |
Get all groups from a workspace. |
| Update Client |
Update a client in a workspace. |
| Update Custom Feed Event |
Update a custom feed entry in a workspace. |
| Update Group |
Update a group in a workspace. |
| Update Groups of an Project |
Update project groups in a workspace. |
| Update Project |
Update a project in a workspace. |
| Update Project Tag |
Update a project tag in a workspace. |
| Update Tags of an Project |
Update project tags in a workspace. |
| Update Tags of an Time |
Update time tags in a workspace. |
| Update Task |
Update a task in a workspace. |
| Update Time |
Update a time in a workspace. |
| Update Time Tag |
Update a time tag in a workspace. |
| Update Users of an Project |
Update project users in a workspace. |
Add Client
Add a client to a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Name
|
name | True | string |
Clients' name |
|
Description
|
description | string |
Description of the client |
|
|
Color
|
color | string |
Color of the project. eg '#0000FF' |
|
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Returns
- Body
- ClientsResponse
Add Custom Feed Event
Add an event to the users feed. Entry is automatically deleted after 180 days.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Name
|
name | True | string |
Entries' name |
|
Description
|
description | string |
Entries' description |
|
|
User
|
id | True | string |
User (or User ID) |
|
Start
|
start | True | date-time |
The start-date and start-time of the feed entry |
|
End
|
end | True | date-time |
The end-date and end-time of the feed entry |
|
Icon Url
|
imageUrl | string |
An icon Url, which is displayed in the feed entry. Best use 96px96px and https. |
|
|
Url
|
url | string |
Url to an external address. E.g. a detail page. This link in the feed can be opened via the context menu. |
|
|
Category
|
category | string |
Use a value that can be filtered later in the interface. For example 'Planner'. |
|
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Returns
Add Group
Add a group to a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Name
|
name | True | string |
Group name |
|
User
|
id | True | string |
User (or User ID) |
Returns
- Body
- GroupsResponse
Add Project
Add a project to a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Name
|
name | True | string |
Projects' name |
|
Description
|
description | string |
Description of the project |
|
|
Client
|
id | True | string |
Client (or Client ID) |
|
Color
|
color | string |
Color of the project eg. '#0000FF' |
|
|
Billable
|
billable | True | boolean |
Indicates whether the project is marked as billable |
|
Completed
|
completed | True | boolean |
Indicates whether the project is marked as completed |
|
Task Based Estimation
|
taskBasedEstimation | True | boolean |
The budget is task-dependent. |
|
Estimation
|
estimation | double |
The estimated budget of the project |
|
|
Private
|
private | boolean |
Set the project to public or private. |
|
|
Hourly Rate
|
hourly_rate | double |
The hourly rate of the project |
|
|
User
|
id | True | string |
User (or User ID) |
|
Role
|
role | True | number |
Role in project |
|
Billable Rate
|
billable_rate | double |
The billable rate of this user in this project |
|
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
|
|
Project-Template
|
templateId | string |
Project-Template (or Project-Template ID) |
Returns
- Body
- ProjectsResponse
Add Project Tag
Add a project tag to a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Name
|
name | True | string |
Tags' name |
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Returns
- response
- array of TagsResponse
Add Task
Add a task to a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Client
|
id | True | string |
Client (or Client ID) |
|
Project
|
id | True | string |
Project (or Project ID) |
|
Name
|
name | True | string |
Tasks' name |
|
Estimation (hours)
|
estimation | double |
The estimated budget of the task |
|
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Returns
- Body
- TasksResponse
Add Time
Add a time to a project within a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Client
|
id | True | string |
Client (or Client ID) |
|
Project
|
id | True | string |
Project (or Project ID) |
|
Name
|
name | True | string |
The name of this time entry (task name) |
|
Start
|
start | True | date-time |
The start-date and start-time of the time entry |
|
End
|
end | date-time |
The end-date and end-time of the time entry |
|
|
Billable
|
billable | True | boolean |
Indicates whether the time is marked as billable |
|
Tag
|
id | True | string |
Tag (or Tag ID) |
|
User
|
id | True | string |
User (or User ID) - if blank, current user is set |
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Returns
- Body
- TimesResponse
Add Time Tag
Add a time tag to a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Name
|
name | True | string |
Tags' name |
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Returns
- response
- array of TagsResponse
Create Times Excel Report
Returns an Excel file containing a report of the specified time.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Date range
|
$filter-date-range | True | string |
Filter times by range |
|
Filter by User
|
$filter-user | string |
Filter the times by user |
|
|
Grouped by Project
|
groupedByProject | True | boolean |
Project times are divided into workbooks |
|
Start Date
|
startDate | string |
Start date for Excel report (overwrites date range) format: yyyy-MM-ddTHH:mm:ss.SSSZ |
|
|
End Date
|
endDate | string |
End date for Excel report (overwrites date range) format: yyyy-MM-ddTHH:mm:ss.SSSZ |
Returns
Excel file
- response
- ExcelResponse
Delete Item
Delete an item from a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Item Type
|
ItemType | True | string |
Type of item that will be deleted |
|
Item ID
|
ItemId | True | string |
ID of the item that will be deleted |
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
Returns
Get Client Projects
Get all projects of one client in one workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Client
|
clientid | True | string |
Client (or Client ID) |
|
Filter Query
|
$filter | string |
An ODATA filter query to restrict the returned projects |
Returns
- response
- array of ProjectsResponse
Get Client Times
Get all times of one client in one workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Client
|
clientid | True | string |
Client (or Client ID) |
|
Date range
|
$filter-date-range | True | string |
Filter times by range |
|
Filter by User
|
$filter-user | string |
Filter the times by user |
|
|
Filter Query
|
$filter | string |
An ODATA filter query to restrict the returned times |
Returns
- response
- array of TimesResponse
Get Clients
Get all clients from a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filter Query
|
$filter | string |
An ODATA filter query to restrict the returned clients |
|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
Returns
- response
- array of ClientsResponse
Get Current User
Get Project Tags
Get all project tags from a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
Returns
- response
- array of TagsResponse
Get Project Tasks
Get all tasks of one project in one workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Client
|
clientid | True | string |
Client (or Client ID) |
|
Project
|
projectid | True | string |
Project (or Project ID) |
|
Filter Query
|
$filter | string |
An ODATA filter query to restrict the returned tasks |
Returns
- response
- array of TasksResponse
Get Project Times
Get all times of one project in one workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Client
|
clientid | True | string |
Client (or Client ID) |
|
Project
|
projectid | True | string |
Project (or Project ID) |
|
Date range
|
$filter-date-range | True | string |
Filter times by range |
|
Filter by User
|
$filter-user | string |
Filter the times by user |
|
|
Filter Query
|
$filter | string |
An ODATA filter query to restrict the returned times |
Returns
- response
- array of TimesResponse
Get Projects
Get all projects from a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filter Query
|
$filter | string |
An ODATA filter query to restrict the returned projects |
|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
Returns
- response
- array of ProjectsResponse
Get Time Tags
Get all time tags from a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
Returns
- response
- array of TagsResponse
Get Times
Get all times from a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Date range
|
$filter-date-range | True | string |
Filter times by range |
|
Filter by User
|
$filter-user | string |
Filter the times by user |
|
|
Filter Query
|
$filter | string |
An ODATA filter query to restrict the returned times |
Returns
- response
- array of TimesResponse
Get Workspace by ID
Returns the workspace
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Workspace
|
workspace_id | True | string |
Workspace Id |
Returns
- Body
- WorkspaceResponse
Get Workspace Groups
Get all groups from a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
Returns
- response
- array of GroupsResponse
Update Client
Update a client in a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Client
|
ClientId | True | string |
Client (or Client ID) |
|
Name
|
name | string |
Clients' name |
|
|
Description
|
description | string |
Description of the client |
|
|
Color
|
color | string |
Color of the project. eg '#0000FF' |
|
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Returns
- Body
- ClientsResponse
Update Custom Feed Event
Update a custom feed entry in a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
ID
|
EventId | True | string |
Custom Feed Event ID |
|
Name
|
name | string |
Entries' name |
|
|
Description
|
description | string |
Entries' description |
|
|
User
|
id | True | string |
User (or User ID) |
|
Start
|
start | date-time |
The start-date and start-time of the feed entry |
|
|
End
|
end | date-time |
The end-date and end-time of the feed entry |
|
|
Icon Url
|
imageUrl | string |
An icon Url, which is displayed in the feed entry. Best use 96px96px and https. |
|
|
Url
|
url | string |
Url to an external address. E.g. a detail page. This link in the feed can be opened via the context menu. |
|
|
Category
|
category | string |
Use a value that can be filtered later in the interface. For example 'Planner'. |
|
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Returns
Update Group
Update a group in a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Group
|
GroupId | True | string |
Group (or Group ID) |
|
Name
|
name | string |
Group name |
|
|
User
|
id | True | string |
User (or User ID) |
Returns
- Body
- GroupsResponse
Update Groups of an Project
Update project groups in a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Project
|
ProjectId | True | string |
Project (or Project ID) |
|
Group
|
id | True | string |
Group (or Group ID) |
|
Role
|
role | True | number |
Role in project |
Returns
- Body
- ProjectsResponse
Update Project
Update a project in a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Project
|
ProjectId | True | string |
Project (or Project ID) |
|
Name
|
name | string |
Projects' name |
|
|
Description
|
description | string |
Description of the project |
|
|
Client
|
id | True | string |
Client (or Client ID) |
|
Color
|
color | string |
Color of the project eg. '#0000FF' |
|
|
Billable
|
billable | boolean |
Indicates whether the project is marked as billable |
|
|
Completed
|
completed | boolean |
Indicates whether the project is marked as completed |
|
|
Task Based Estimation
|
taskBasedEstimation | boolean |
The budget is task-dependent. |
|
|
Estimation
|
estimation | double |
The estimated budget of the project |
|
|
Private
|
private | boolean |
Set the project to public or private. |
|
|
Hourly Rate
|
hourly_rate | double |
The hourly rate of the project |
|
|
User
|
id | True | string |
User (or User ID) |
|
Role
|
role | True | number |
Role in project |
|
Billable Rate
|
billable_rate | double |
The billable rate of this user in this project |
|
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Returns
- Body
- ProjectsResponse
Update Project Tag
Update a project tag in a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Tag
|
TagId | True | string |
Tag (or Tag ID) |
|
Name
|
name | string |
Tags' name |
|
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Returns
- response
- array of TagsResponse
Update Tags of an Project
Update project tags in a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Project
|
ProjectId | True | string |
Project (or Project ID) |
|
Tag
|
id | True | string |
Tag (or Tag ID) |
Returns
- Body
- ProjectsResponse
Update Tags of an Time
Update time tags in a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Time ID
|
TimeId | True | string |
Unique ID of time to be updated |
|
Tag
|
id | True | string |
Tag (or Tag ID) |
Returns
- Body
- TimesResponse
Update Task
Update a task in a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Task ID
|
TaskId | True | string |
Unique ID of the task |
|
Client
|
id | True | string |
Client (or Client ID) |
|
Project
|
id | True | string |
Project (or Project ID) |
|
Name
|
name | string |
Tasks' name |
|
|
Estimation (hours)
|
estimation | double |
The estimated budget of the task |
|
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Returns
- Body
- TasksResponse
Update Time
Update a time in a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Time ID
|
TimeId | True | string |
Unique ID of time to be updated |
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Client
|
id | True | string |
Client (or Client ID) |
|
Project
|
id | True | string |
Project (or Project ID) |
|
Name
|
name | string |
The name of this time entry (task name) |
|
|
Start
|
start | date-time |
The start-date and start-time of the time entry |
|
|
End
|
end | date-time |
The end-date and end-time of the time entry |
|
|
Billable
|
billable | boolean |
Indicates whether the time is marked as billable |
|
|
Tag
|
id | True | string |
Tag (or Tag ID) |
|
User
|
id | True | string |
User (or User ID) - if blank, current user is set |
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Returns
- Body
- TimesResponse
Update Time Tag
Update a time tag in a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Tag
|
TagId | True | string |
Tag (or Tag ID) |
|
Name
|
name | string |
Tags' name |
|
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Returns
- response
- array of TagsResponse
Update Users of an Project
Update project users in a workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Project
|
ProjectId | True | string |
Project (or Project ID) |
|
User
|
id | True | string |
User (or User ID) |
|
Role
|
role | True | number |
Role in project |
|
Billable Rate
|
billable_rate | double |
The billable rate of this user in this project |
Returns
- Body
- ProjectsResponse
Triggers
| Client Trigger |
If a client is created, changed or deleted in timeghost, this trigger runs. |
| Project Trigger |
If a project is created, changed or deleted in timeghost, this trigger runs. |
| Tag Trigger |
If a tag is created, changed or deleted in timeghost, this trigger runs. |
| Task Trigger |
If a task is created, changed or deleted in timeghost, this trigger runs. |
| Time Trigger |
If a time is created, changed or deleted in timeghost, this trigger runs. |
Client Trigger
If a client is created, changed or deleted in timeghost, this trigger runs.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Name of the webhook
|
name | True | string |
The name of the webhook so that it can be found in the settings in timeghost. |
|
Run on
|
events | array of string |
Select the events to listen to |
Returns
- Body
- ClientsResponse
Project Trigger
If a project is created, changed or deleted in timeghost, this trigger runs.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Name of the webhook
|
name | True | string |
The name of the webhook so that it can be found in the settings in timeghost. |
|
Run on
|
events | array of string |
Select the events to listen to |
Returns
- Body
- ProjectsResponse
Tag Trigger
If a tag is created, changed or deleted in timeghost, this trigger runs.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Name of the webhook
|
name | True | string |
The name of the webhook so that it can be found in the settings in timeghost. |
|
Run on
|
events | array of string |
Select the events to listen to |
Returns
- Body
- TagsResponse
Task Trigger
If a task is created, changed or deleted in timeghost, this trigger runs.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Name of the webhook
|
name | True | string |
The name of the webhook so that it can be found in the settings in timeghost. |
|
Run on
|
events | array of string |
Select the events to listen to |
Returns
- Body
- TasksResponse
Time Trigger
If a time is created, changed or deleted in timeghost, this trigger runs.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace-id | True | string |
Enter the workspace (workspace id) in which your data is stored |
|
Name of the webhook
|
name | True | string |
The name of the webhook so that it can be found in the settings in timeghost. |
|
Run on
|
events | array of string |
Select the events to listen to |
Returns
- Body
- TimesResponse
Definitions
ProjectsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Unique ID of the project |
|
Project Type
|
projectType | string |
Project or Template |
|
Deleted
|
deleted | boolean |
Indicates whether the project is marked as deleted |
|
Created
|
created | date-time |
Indicates when the project was created |
|
Modified
|
modified | date-time |
Indicates when the project was changed |
|
Status
|
status | string |
Indicates whether the data record was just created, updated or deleted |
|
Name
|
name | string |
Projects' name |
|
ID
|
client.id | string |
Unique ID of the client of this project |
|
Clients' name
|
client.name | string |
Clients' name |
|
Billable time
|
timesRecorded.billable | number |
Summary of billable times in this project |
|
Not billable time
|
timesRecorded.notBillable | number |
Summary of not billable times in this project |
|
Description
|
description | string |
Description of the project |
|
Color
|
color | string |
Color of the project. eg '#0000FF' |
|
Billable
|
billable | boolean |
Indicates whether the project is marked as billable |
|
Completed
|
completed | boolean |
Indicates whether the project is marked as completed |
|
Estimation
|
estimation | double |
The estimated budget of the project |
|
Task Based Estimation
|
taskBasedEstimation | boolean |
The budget is task-dependent. |
|
Hourly Rate
|
hourly_rate | double |
Hourly rate of this project |
|
Private
|
private | boolean |
Indicates whether the project is marked as private |
|
tags
|
tags | array of object | |
|
Tag ID
|
tags.id | string |
Unique ID of the tag of this project |
|
Tags' name
|
tags.name | string |
Tags' name |
|
Users
|
users | array of object |
Users of the project |
|
User ID
|
users.id | string |
Unique ID of the user of this project |
|
Users' role
|
users.role | number |
Users' role |
|
Billable Rate
|
users.billable_rate | double |
Billable rate of this user in this project |
|
Groups
|
groups | array of object |
Groups of the project |
|
Group ID
|
groups.id | string |
Unique ID of the group of this project |
|
Groups' role
|
groups.role | number |
Groups' role |
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
ClientsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Unique ID of the client |
|
Deleted
|
deleted | boolean |
Indicates whether the client is marked as deleted |
|
Name
|
name | string |
Clients' name |
|
Description
|
description | string |
Description of the client |
|
Created
|
created | date-time |
Indicates when the client was created |
|
Modified
|
modified | date-time |
Indicates when the client was changed |
|
Status
|
status | string |
Indicates whether the data record was just created, updated or deleted |
|
Color
|
color | string |
The color of the client |
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
TimesResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Unique ID of the time |
|
Name of the time
|
name | string |
Name of the time |
|
Deleted
|
deleted | boolean |
Indicates whether the time is marked as deleted |
|
Billable
|
billable | boolean |
Indicates whether the time is marked as billable |
|
Client ID
|
client.id | string |
Unique ID of the client of this time |
|
Clients' name
|
client.name | string |
Clients' name |
|
Project ID
|
project.id | string |
Unique ID of the project of this time |
|
Projects' name
|
project.name | string |
Projects' name |
|
Completed
|
project.completed | boolean |
Indicates whether the project is marked as completed |
|
tags
|
project.tags | array of object | |
|
Tag ID
|
project.tags.id | string |
Unique ID of the tag of this project |
|
Tags' name
|
project.tags.name | string |
Tags' name |
|
Task ID
|
task.id | string |
Unique ID of the task of this time |
|
Tasks' name
|
task.name | string |
Tasks' name |
|
Completed
|
task.completed | boolean |
Indicates whether the task is marked as completed |
|
User ID
|
user.id | string |
Unique ID of the user of this time |
|
Users' name
|
user.name | string |
Users' name |
|
Duration
|
timeDiff | number |
The duration of the time entry |
|
Start
|
start | date-time |
The start-date and start-time of the time entry |
|
End
|
end | date-time |
The end-date and end-time of the time entry |
|
tags
|
tags | array of object | |
|
Tag ID
|
tags.id | string |
Unique ID of the tag of this time |
|
Tags' name
|
tags.name | string |
Tags' name |
|
Created
|
created | date-time |
Indicates when the time was created |
|
Modified
|
modified | date-time |
Indicates when the time was changed |
|
Status
|
status | string |
Indicates whether the data record was just created, updated or deleted |
|
Timezone
|
timeZone | date-time |
Indicates in which timezone the time was created |
|
Earning
|
amount | double |
The earnings of the time entry |
|
Cost
|
cost | double |
The labor cost of the time entry |
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
TasksResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Unique ID of the task |
|
Deleted
|
deleted | boolean |
Indicates whether the task is marked as deleted |
|
Created
|
created | date-time |
Indicates when the task was created |
|
Modified
|
modified | date-time |
Indicates when the task was changed |
|
Completed
|
completed | boolean |
Indicates whether the task is marked as completed |
|
Billable time
|
timesRecorded.billable | number |
Summary of billable times in this task |
|
Not billable time
|
timesRecorded.notBillable | number |
Summary of not billable times in this task |
|
Status
|
status | string |
Indicates whether the data record was just created, updated or deleted |
|
Name
|
name | string |
Tasks' Name |
|
Client ID
|
client.id | string |
Unique ID of the client of this task |
|
Clients' Name
|
client.name | string |
Clients' Name |
|
Project ID
|
project.id | string |
Unique ID of the project of this task |
|
Projects' name
|
project.name | string |
Projects' name |
|
Estimation
|
estimation | double |
The estimated budget of the task |
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
GroupsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Unique ID of the group |
|
Name
|
name | string |
Tags' name |
|
Synchronized
|
synchronizedGroup | boolean |
Indicates whether the group is synchonized |
|
users
|
users | array of object | |
|
User ID
|
users.id | string |
Unique ID of the user |
|
Name
|
users.name | string |
User-Name |
TagsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Unique ID of the tag |
|
Deleted
|
deleted | boolean |
Indicates whether the tag is marked as deleted |
|
Created
|
created | date-time |
Indicates when the tag was created |
|
Modified
|
modified | date-time |
Indicates when the tag was changed |
|
Status
|
status | string |
Indicates whether the data record was just created, updated or deleted |
|
Name
|
name | string |
Tags' name |
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
CustomFeedEventResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Unique ID of the custom feed event |
|
Deleted
|
deleted | boolean |
Indicates whether the custom feed event is marked as deleted |
|
Created
|
created | date-time |
Indicates when the custom feed event was created |
|
Modified
|
modified | date-time |
Indicates when the custom feed event was changed |
|
Status
|
status | string |
Indicates whether the data record was just created, updated or deleted |
|
Name
|
name | string |
Custom Feed Events' name |
|
Description
|
description | string |
Entries' description |
|
Start
|
start | date-time |
The start-date and start-time of the feed entry |
|
End
|
end | date-time |
The end-date and end-time of the feed entry |
|
Icon Url
|
imageUrl | string |
An icon Url, which is displayed in the feed entry. Best use 96px96px and https. |
|
Url
|
url | string |
Url to an external address. E.g. a detail page. This link in the feed can be opened via the context menu. |
|
Category
|
category | string |
This value can be used to filter the feeds in the interface. |
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
ExcelResponse
UserResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Unique ID of the user |
|
Deleted
|
deleted | boolean |
Indicates whether the tag is marked as deleted |
|
E-Mail
|
string |
User's email adress |
|
|
Default workspace ID
|
defaultWorkspace | string |
The workspace Id of the default workspace of the user |
|
workspaces
|
workspaces | array of object | |
|
Workspace ID
|
workspaces.id | string |
Unique ID of the workspace |
|
Workspace-Name
|
workspaces.name | string |
Workspace-Name |
WorkspaceResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Unique ID of the user |
|
Name
|
name | string |
Workspace name |
|
Description
|
description | string |
Workspace description |
|
New projects are billable as default
|
settings.isNewProjectBillable | boolean |
Indicates if new projects are billable as default |
|
Hourly Rate
|
settings.hourly_rate | double |
The default hourly rate of this workspace |
|
Currency
|
settings.currency | string |
The currency name of this project |
|
Future time tracking allowed?
|
settings.allowFutureTimeTracking | boolean |
Indicates if future time trackis is allowed |
|
Status
|
subscription.status | string |
The status of the workspace subscription |
|
End
|
subscription.end | date-time |
The end time of the subscription |
|
Quantity
|
subscription.quantity | double |
The quantity of licences in this workspace |
|
Recurring interval
|
subscription.recurringInterval | string |
The recurring interval of the subscription |
|
Currency
|
subscription.currency | string |
The currency of the workspace subscription |
|
users
|
users | array of object | |
|
User ID
|
users.id | string |
Unique ID of the user |
|
Name
|
users.name | string |
User-Name |
|
E-Mail
|
users.email | string |
Users' email |
|
Is admin
|
users.admin | boolean |
Indicates if the user has a admin role in the workspace |
|
Hourly Rate
|
users.billable_rate | double |
The hourly rate of the user in this workspace |
|
Labor Cost
|
users.labor_cost | double |
The labor cost of the user in this workspace |
|
groups
|
groups | array of object | |
|
User ID
|
groups.id | string |
Unique ID of the group |
|
Name
|
groups.name | string |
Group-Name |
|
users
|
groups.users | array of object | |
|
User ID
|
groups.users.id | string |
Unique ID of the user |
|
Name
|
groups.users.name | string |
User-Name |
|
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |