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 |
support@timeghost.io |
Connector Metadata | |
---|---|
Publisher | timeghost.io |
Website | https://timeghost.io |
Privacy policy | https://timeghost.io/privacy-policy/ |
Categories | Productivity;Business Intelligence |
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 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.
Supported Operations
The connector supports the following operations:
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 Project
: Add a project to a workspace.Add Task
: Add a task to a workspace.Add Time
: Add a time to a project within a workspace.Add Tag
: Add a time tag or a project tag to a workspace.Add Group
: Add a group to a workspace.Add ComeGo
: Add a working hour to a workspace.Create Times Excel Report
: Returns an Excel file containing a report of the specified time.Delete Item
: Deletes 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 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 Tags
: Get all tags from a workspace.Get Times
: Get all times from a workspace.Get Currentuser
: Get the Currentuser from a workspace.Get Workspace by Id
: Get workspace by id.Get Groups
: Get all groups from a workspace.Get ComeGo
: Get all working hours from a workspace.Update Client
: Updates a client in a workspace.Update Custom Feed Event
: Updates a custom feed entry in a workspace.Update Project Tags
: Updates project tags in a workspace.Update Project User
: Updates users of a project in a workspace.Update Project Groups
: Updates a group of a project in a workspace.Update Group
: Updates a group in a workspace.Update Task
: Updates a task in a workspace.Update Time
: Updates a time in a workspace.Update Time tag
: Updates a tag of a time in a workspace.Update Tag
: Updates a time tag or a project tag in a workspace.Update ComeGo
: Updates a working hour in a workspace.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.
Deployment instructions
Please use these instructions to deploy this connector as a custom connector in Microsoft Power Automate and Power Apps.
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.
Known issues and limitations
No known issues and limitations.
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 any Tag |
Add a time tag to a workspace. |
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 Task |
Add a task to a workspace. |
Add Time |
Add a time to a project within a workspace. |
Add Working hours |
Add working hours 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 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 Tags |
Get all tags from a workspace. |
Get Times |
Get all times from a workspace. |
Get Working hours |
Get all Working hours from a workspace. |
Get Workspace by ID |
Returns the workspace |
Get Workspace Groups |
Get all groups from a workspace. |
Update any Tag |
Update a time tag in 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 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 Users of an Project |
Update project users in a workspace. |
Update Working Hours |
Update Working hours in a workspace. |
Add any 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 |
tagType
|
tagType | True | integer |
Choose 0 for a Project tag or 1 for a Time tag |
Returns
- Body
- TagsResponse
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 |
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
|
id | True | string |
User ID |
Synchronized Group
|
synchronizedGroup | boolean |
Indicates whether the group is synchronized |
|
Synchronized Group Type
|
synchronizedGroupType | string |
Type of the synchronized group, if applicable |
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 |
Project's name |
Description
|
description | string |
Description of the project |
|
Client
|
id | True | string |
Client (or Client ID) |
Name
|
name | string |
Client name |
|
Color
|
color | string |
Color of the project eg. '#0000FF' |
|
Billable
|
billable | True | boolean |
Indicates whether the project is marked as billable |
Completed
|
completed | 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 | True | boolean |
Set the project to public or private. |
Project Type
|
projectType | string |
Set the project type |
|
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 |
|
Removed
|
removed | boolean |
Indicates whether the user is removed from the project |
|
Tags
|
tags | array of string |
Tags associated with the project |
|
Groups
|
groups | array of string |
Groups associated with the project |
|
Who Can Add Tasks
|
whoCanAddTasks | integer |
Who can add tasks to this project (e.g., 1 = Manager only, 2 = Everyone) |
|
Template ID
|
templateId | string |
The ID of the project template |
|
Template Copy Rate
|
templateCopyRate | boolean |
Indicates whether to copy the rate from the template |
|
Template Copy Tasks
|
templateCopyTasks | boolean |
Indicates whether to copy tasks from the template |
|
Template Copy Task Assign
|
templateCopyTaskAssign | boolean |
Indicates whether to copy task assignments from the template |
Returns
- Body
- ProjectsResponse
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 |
Name
|
name | True | string |
Task's name |
Estimation (seconds)
|
estimation | True | double |
The estimated duration of the task in seconds |
Project
|
id | True | string |
Project (or Project ID) |
Name
|
name | string |
Project name |
|
Cosmos Entity Name
|
cosmosEntityName | string |
Entity name in Cosmos DB |
|
Deleted
|
deleted | boolean |
Indicates if the project has been deleted |
|
Editor
|
editor | string |
Last editor of the project |
|
ID
|
id | True | string |
Group ID |
Name
|
name | True | string |
Group name |
Users
|
users | array of string |
Users assigned to this group |
|
Synchronized Group
|
synchronizedGroup | boolean |
Indicates if the group is synchronized |
|
Assigned Users
|
assignedToUsers | array of string | ||
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Returns
- Body
- TasksUpdateResponse
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) |
Task
|
id | True | string |
Task (or Task ID) |
Cosmos Entity Name
|
cosmosEntityName | string |
Entity name used in Cosmos DB for tasks |
|
Deleted
|
deleted | boolean |
Indicates whether the task has been deleted |
|
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, format: yyyy-MM-ddTHH:mm:ss.SSSZ |
End
|
end | date-time |
The end-date and end-time of the time entry, format: yyyy-MM-ddTHH:mm:ss.SSSZ |
|
Billable
|
billable | True | boolean |
Indicates whether the time is marked as billable |
Cosmos Entity Name
|
cosmosEntityName | string |
Entity name used in Cosmos DB for tags |
|
Deleted
|
deleted | boolean |
Indicates whether the tag has been deleted |
|
Editor
|
editor | string |
The last editor of the tag |
|
Time Zone
|
timeZone | string |
The time zone for the time entry |
|
Input Mode
|
inputMode | string |
The input mode for the time entry (e.g., range) |
|
Outlook Calendar Reference
|
outlookCalenderReference | string |
Reference to an Outlook calendar event, if applicable |
Returns
- Body
- TimesResponse
Add Working hours
Add working hours 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 | string |
The name of the entry, can be null |
|
Start Time
|
start | date-time |
The start time of the work entry in ISO 8601 format |
|
End Time
|
end | date-time |
The end time of the work entry in ISO 8601 format, can be null if ongoing |
|
Type
|
type | string |
The type of entry (e.g., 'work') |
|
Time Zone
|
timeZone | string |
The time zone in which the entry was recorded (e.g., 'Europe/Berlin') |
|
User ID
|
id | string |
Unique ID of the user associated with this entry |
Returns
- Body
- ComeGoResponse
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 |
startDate
|
startDate | True | date-time | |
endDate
|
endDate | True | date-time | |
billable
|
billable | string | ||
client
|
client | boolean | ||
project
|
project | boolean | ||
projectDescription
|
projectDescription | boolean | ||
task
|
task | boolean | ||
description
|
description | boolean | ||
author
|
author | boolean | ||
groupedByProject
|
groupedByProject | True | boolean | |
projectStatus
|
projectStatus | string | ||
enabled
|
enabled | boolean | ||
minutes
|
minutes | integer | ||
type
|
type | string | ||
timeZone
|
timeZone | string | ||
users
|
users | array of uuid |
Returns
Excel file
- Excel file
- object
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 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 | 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 TasksUpdateResponse
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 | 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 Tags
Get all 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 |
Filter Query
|
$filter | string |
An ODATA filter query to restrict the returned projects |
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 Working hours
Get all Working hours 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 |
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 ComeGoResponse
Get Workspace by ID
Returns the workspace
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Workspace
|
workspace-id | 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 any 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 | True | string |
Tag's name |
Tag Type
|
tagType | True | integer |
The type of the tag |
External ID
|
externalId | string |
This value can be used to store an ID from another system for mapping. |
|
Cosmos Entity Name
|
cosmosEntityName | string |
Entity name used in Cosmos DB |
|
Deleted
|
deleted | boolean |
Indicates whether the tag has been deleted |
|
Author
|
author | string |
The author of the tag |
|
Editor
|
editor | string |
The last editor of the tag |
|
Workspace ID
|
id | string |
Workspace ID |
|
Partition Key
|
partitionKey | string |
Partition key in Cosmos DB |
|
Status
|
status | string |
The status of the tag |
|
Created
|
created | date-time |
Creation timestamp of the tag |
|
Modified
|
modified | date-time |
Last modified timestamp of the tag |
Returns
- Body
- TagsResponse
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 | True | string |
Client's name |
Description
|
description | string |
Description of the client |
|
Color
|
color | string |
Color of the client, e.g., '#0000FF' |
|
External ID
|
externalId | string |
This value can be used to store an ID from another system for mapping. |
|
Cosmos Entity Name
|
cosmosEntityName | string |
Entity name used in Cosmos DB |
|
Deleted
|
deleted | boolean |
Indicates whether the client has been deleted |
|
Author
|
author | string |
The author of the client |
|
Editor
|
editor | string |
The last editor of the client |
|
Workspace ID
|
id | string |
Workspace ID |
|
Partition Key
|
partitionKey | string |
Partition key in Cosmos DB |
|
Status
|
status | string |
The status of the client |
|
Created
|
created | date-time |
Creation timestamp of the client |
|
Modified
|
modified | date-time |
Last modified timestamp of the client |
|
Phone
|
phone | string |
Phone number |
|
Location
|
location | string |
Location of the client |
|
Email
|
string |
Email of the client |
||
Primary Contact
|
primaryContact | string |
Primary contact name |
|
Secondary Contact
|
secondaryContact | string |
Secondary contact name |
|
Onboard Date
|
onboardDate | date |
Date when the client was onboarded |
|
Industry
|
industry | string |
Industry of the client |
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) |
ID
|
id | True | string |
Group ID |
Name
|
name | True | string |
Group name |
Synchronized Group
|
synchronizedGroup | boolean |
Indicates whether the group is synchronized |
|
Synchronized Group Type
|
synchronizedGroupType | string |
Type of the synchronized group, if applicable |
|
User ID
|
id | True | string |
User ID |
Email
|
True | string |
User email |
|
Name
|
name | string |
User name |
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 | True | string |
Project's name |
Description
|
description | string |
Description of the project |
|
Client
|
id | True | string |
Client (or Client ID) |
Name
|
name | string |
Client name |
|
Color
|
color | string |
Color of the project eg. '#0000FF' |
|
Billable
|
billable | True | boolean |
Indicates whether the project is marked as billable |
Completed
|
completed | 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 | True | boolean |
Set the project to public or private. |
Hourly Rate
|
hourly_rate | double |
The hourly rate of the project |
|
Hourly Rate Enabled
|
hourly_rate_enabled | boolean |
Indicates whether the hourly rate is enabled for 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 |
|
Tag ID
|
id | True | string |
Tag ID |
Tag Name
|
name | True | string |
Tag name |
Groups
|
groups | array of string |
Groups associated with the project |
|
Who Can Add Tasks
|
whoCanAddTasks | integer |
Who can add tasks to this project (e.g., 1 = Manager only, 2 = Everyone) |
|
Status
|
status | string |
The status of the project |
|
Workspace ID
|
id | string |
Workspace ID |
|
Cosmos Entity Name
|
cosmosEntityName | string |
Entity name used in Cosmos DB |
|
Author
|
author | string |
Author of the project |
|
Editor
|
editor | string |
Editor of the project |
|
Partition Key
|
partitionKey | string |
Partition key in Cosmos DB |
Returns
- Body
- ProjectsResponse
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
|
TaskId | True | string |
Task (or Task ID) |
Name
|
name | string |
Task's name |
|
Estimation (seconds)
|
estimation | double |
The estimated duration of the task in seconds |
|
Completed
|
completed | boolean |
Indicates whether the task is marked as completed |
|
Client
|
id | True | string |
Client (or Client ID) |
Name
|
name | string |
Client name |
|
Project
|
id | True | string |
Project (or Project ID) |
Name
|
name | string |
Project name |
|
Completed
|
completed | boolean |
Indicates whether the project is marked as completed |
|
ID
|
id | True | string |
Group ID |
Name
|
name | True | string |
Group name |
Assigned Users
|
assignedToUsers | array of string | ||
Status
|
status | string |
The status of the task |
|
Billable Time
|
billable | double |
Billable time recorded for this task |
|
Non-Billable Time
|
notBillable | double |
Non-billable time recorded for this task |
|
Workspace ID
|
id | string |
Workspace ID |
|
Cosmos Entity Name
|
cosmosEntityName | string |
Entity name used in Cosmos DB |
|
Partition Key
|
partitionKey | string |
Partition key in Cosmos DB |
|
Created
|
created | date-time |
Creation timestamp of the task |
|
Modified
|
modified | date-time |
Last modified timestamp of the task |
|
Author
|
author | string |
Author of the task |
|
Editor
|
editor | string |
Last editor of the task |
|
Can Create Time
|
canCreateTime | boolean |
Indicates if time entries can be created for this task |
|
Can Edit
|
canEdit | boolean |
Indicates if the current user can edit this task |
Returns
- Body
- TasksUpdateResponse
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) |
Name
|
name | string |
Client name |
|
Project
|
id | True | string |
Project (or Project ID) |
Name
|
name | string |
Project name |
|
Completed
|
completed | boolean |
Indicates whether the project is completed |
|
Task
|
id | True | string |
Task (or Task ID) |
Name
|
name | string |
Task name |
|
Completed
|
completed | boolean |
Indicates whether the task is completed |
|
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, format: yyyy-MM-ddTHH:mm:ss.SSSZ |
|
End
|
end | date-time |
The end-date and end-time of the time entry, format: yyyy-MM-ddTHH:mm:ss.SSSZ |
|
Billable
|
billable | boolean |
Indicates whether the time is marked as billable |
|
ID
|
id | True | string |
Tag ID |
Name
|
name | string |
Tag name |
|
Time Zone
|
timeZone | string |
The time zone for the time entry |
|
Input Mode
|
inputMode | string |
The input mode for the time entry (e.g., range) |
|
Time Difference
|
timeDiff | integer |
Time difference in seconds |
|
Outlook Calendar Reference
|
outlookCalenderReference | string |
Reference to an Outlook calendar event, if applicable |
|
Cosmos Entity Name
|
cosmosEntityName | string |
Entity name used in Cosmos DB |
|
Partition Key
|
partitionKey | string |
Partition key in Cosmos DB |
|
Status
|
status | string |
The status of the time entry |
|
User
|
id | True | string |
User (or User ID) - if blank, current user is set |
Name
|
name | string |
User name |
|
Workspace ID
|
id | string |
Workspace ID |
|
Created
|
created | date-time |
Creation timestamp of the time entry |
|
Modified
|
modified | date-time |
Last modified timestamp of the time entry |
Returns
- Body
- TimesResponse
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
Update Working Hours
Update Working hours 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 |
Entity Name
|
cosmosEntityName | string |
The entity type, always 'comego' |
|
Deleted
|
deleted | boolean |
Indicates whether the entry is marked as deleted |
|
Editor ID
|
editor | string |
The ID of the user who last edited the entry |
|
Author ID
|
author | string |
The ID of the user who created the entry |
|
Created Timestamp
|
created | date-time |
The timestamp when the entry was created |
|
Modified Timestamp
|
modified | date-time |
The timestamp when the entry was last modified |
|
Entry ID
|
id | string |
Unique ID of the ComeGo entry |
|
Status
|
status | string |
The status of the entry (e.g., 'new') |
|
Start Time
|
start | date-time |
The start time of the work entry in ISO 8601 format |
|
End Time
|
end | date-time |
The end time of the work entry in ISO 8601 format |
|
Name
|
name | string |
The name of the entry, can be null |
|
Partition Key
|
partitionKey | string |
The partition key for the entry in CosmosDB |
|
Time Zone
|
timeZone | string |
The time zone in which the entry was recorded (e.g., 'Europe/Berlin') |
|
Type
|
type | string |
The type of entry (e.g., 'work') |
|
User ID
|
id | string |
Unique ID of the user associated with this entry |
|
User Name
|
name | string |
Name of the user associated with this entry |
|
Workspace ID
|
id | string |
Unique ID of the workspace |
|
Tags
|
tags | array of string |
An array of tags associated with the entry |
|
User Can Edit
|
currentUserCanEdit | boolean |
Indicates whether the current user can edit the entry |
Returns
- Body
- ComeGoResponse
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
- TasksUpdateResponse
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 |
Name
|
name | string |
Projects' name |
Description
|
description | string |
Description of the project |
Billable
|
billable | boolean |
Indicates whether the project is marked as billable |
Task Based Estimation
|
taskBasedEstimation | boolean |
Indicates if the budget is task-dependent |
Estimation
|
estimation | double |
The estimated budget of the project |
Completed
|
completed | boolean |
Indicates whether the project is marked as completed |
Use as Default
|
useAsDefault | boolean |
Indicates if this project is used as the default |
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 |
Earnings
|
earnings | double |
Earnings from the project |
Hourly Rate Enabled
|
hourly_rate_enabled | boolean |
Indicates if hourly rate is enabled |
Hourly Rate
|
hourly_rate | double |
Hourly rate of this project |
Color
|
color | string |
Color of the project. eg '#0000FF' |
Private
|
private | boolean |
Indicates whether the project is marked as private |
Status
|
status | string |
Indicates whether the data record was just created, updated or deleted |
Client ID
|
client.id | string |
Unique ID of the client |
Client Name
|
client.name | string |
Name of the client |
tags
|
tags | array of object | |
Tag ID
|
tags.id | string |
Unique ID of the tag |
Tag Name
|
tags.name | string |
Name of the tag |
users
|
users | array of object | |
User ID
|
users.id | string |
Unique ID of the user |
Role
|
users.role | number |
Role of the user in the project |
Billable Rate
|
users.billable_rate | double |
Billable rate of the user in this project |
Removed
|
users.removed | boolean |
Indicates if the user was removed from the project |
groups
|
groups | array of object | |
Group ID
|
groups.id | string |
Unique ID of the group |
Role
|
groups.role | number |
Role of the group in the project |
Removed
|
groups.removed | boolean |
Indicates if the group was removed from the project |
Workspace ID
|
workspace.id | string |
Unique ID of the workspace |
Partition Key
|
partitionKey | string |
Partition key for CosmosDB |
Cosmos Entity Name
|
cosmosEntityName | string |
Cosmos entity name for this project |
Can Edit
|
currentUserCanEdit | boolean |
Indicates if the current user can edit the project |
ClientsResponse
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
Unique ID of the client |
Name
|
name | string |
Client's name |
Description
|
description | string |
Description of the client |
Color
|
color | string |
The color associated with the client |
Deleted
|
deleted | boolean |
Indicates whether the client is marked as deleted |
Use as Default
|
useAsDefault | boolean |
Indicates if this client is used as the default |
Status
|
status | string |
Indicates whether the data record was just created, updated, or deleted |
Created
|
created | date-time |
Timestamp when the client was created |
Modified
|
modified | date-time |
Timestamp when the client was last modified |
Cosmos Entity Name
|
cosmosEntityName | string |
Cosmos entity name for this client |
Partition Key
|
partitionKey | string |
Partition key for CosmosDB |
Workspace ID
|
workspace.id | string |
Unique ID of the workspace |
Phone
|
meta.phone | string |
Phone number of the client |
Location
|
meta.location | string |
Location of the client |
Email
|
meta.email | string |
Email address of the client |
Primary Contact
|
meta.primaryContact | string |
Primary contact for the client |
Secondary Contact
|
meta.secondaryContact | string |
Secondary contact for the client |
Onboard Date
|
meta.onboardDate | date |
Onboarding date of the client |
Tax Rate
|
meta.taxRate | string |
Tax rate applicable to the client |
External ID
|
meta.externalId | string |
External ID for mapping with another system |
Can Edit
|
currentUserCanEdit | boolean |
Indicates if the current user can edit the client |
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 |
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 |
Duration
|
timeDiff | number |
The duration of the time entry |
Timezone
|
timeZone | string |
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 |
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 |
Use as Default
|
project.useAsDefault | boolean |
Indicates if this project is used as the default |
tags
|
project.tags | array of object | |
Tag ID
|
project.tags.id | string |
Unique ID of the tag |
Tag Name
|
project.tags.name | string |
Name of the tag |
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 |
Client ID
|
client.id | string |
Unique ID of the client of this time |
Clients' name
|
client.name | string |
Clients' name |
User ID
|
user.id | string |
Unique ID of the user of this time |
Users' name
|
user.name | string |
Users' name |
tags
|
tags | array of object | |
Tag ID
|
tags.id | string |
Unique ID of the tag of this time |
Tag Name
|
tags.name | string |
Name of the tag |
Outlook Calendar Reference
|
outlookCalenderReference | string |
Reference to an Outlook calendar event |
Workspace ID
|
workspace.id | string |
Unique ID of the workspace |
Time Overlap
|
hasTimeOverlap | boolean |
Indicates if there is a time overlap |
Input Mode
|
inputMode | string |
The mode of input, e.g., 'range' |
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 |
Cosmos Entity Name
|
cosmosEntityName | string |
Cosmos entity name for this time |
Partition Key
|
partitionKey | string |
Partition key for CosmosDB |
Can Edit
|
currentUserCanEdit | boolean |
Indicates if the current user can edit the time entry |
TasksUpdateResponse
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
Unique ID of the task |
Name
|
name | string |
Tasks' Name |
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 |
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 |
Project Completed
|
project.completed | boolean |
Indicates whether the project is marked as completed |
Estimation
|
estimation | double |
The estimated budget of the task |
assignedToUsers
|
assignedToUsers | array of object | |
User ID
|
assignedToUsers.id | string |
Unique ID of the assigned user |
User Name
|
assignedToUsers.name | string |
Name of the assigned user |
assignedToGroups
|
assignedToGroups | array of object | |
Group ID
|
assignedToGroups.id | string |
Unique ID of the assigned group |
Group Name
|
assignedToGroups.name | string |
Name of the assigned group |
Workspace ID
|
workspace.id | string |
Unique ID of the workspace |
Cosmos Entity Name
|
cosmosEntityName | string |
Cosmos entity name for this task |
Partition Key
|
partitionKey | string |
Partition key for CosmosDB |
Can Edit
|
currentUserCanEdit | boolean |
Indicates if the current user can edit the task |
GroupsResponse
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
Unique ID of the group |
Name
|
name | string |
Group's name |
Synchronized
|
synchronizedGroup | boolean |
Indicates whether the group is synchronized |
Synchronized Group Type
|
synchronizedGroupType | string |
Type of synchronized group (e.g., 'teams') |
users
|
users | array of object | |
User ID
|
users.id | string |
Unique ID of the user |
Name
|
users.name | string |
User's name |
Workspace ID
|
workspace.id | string |
Unique ID of the workspace |
Cosmos Entity Name
|
cosmosEntityName | string |
Cosmos entity name for this group |
Partition Key
|
partitionKey | string |
Partition key for CosmosDB |
Created
|
created | date-time |
Indicates when the group was created |
Modified
|
modified | date-time |
Indicates when the group was changed |
Status
|
status | string |
Indicates whether the data record was just created, updated, or deleted |
Can Edit
|
currentUserCanEdit | boolean |
Indicates if the current user can edit the group |
TagsResponse
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
Unique ID of the tag |
Name
|
name | string |
Tag's name |
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 |
External ID
|
externalId | string |
This value can be used to store an ID from another system. To have a simple mapping. |
Tag Type
|
tagType | integer |
Type of the tag (e.g., category identifier) |
Workspace ID
|
workspace.id | string |
Unique ID of the workspace |
Cosmos Entity Name
|
cosmosEntityName | string |
Cosmos entity name for this tag |
Partition Key
|
partitionKey | string |
Partition key for CosmosDB |
Can Edit
|
currentUserCanEdit | boolean |
Indicates if the current user can edit the tag |
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. |
UserResponse
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
Unique ID of the user |
Deleted
|
deleted | boolean |
Indicates whether the user is marked as deleted |
E-Mail
|
string |
User's email address |
|
Default Workspace ID
|
defaultWorkspace | string |
The workspace ID of the user's default workspace |
workspaces
|
workspaces | array of object | |
Workspace ID
|
workspaces.id | string |
Unique ID of the workspace |
Workspace Name
|
workspaces.name | string |
Name of the workspace |
Capture Manual Mode
|
settings.captureManualMode | boolean |
Indicates if manual capture mode is enabled |
Feed Show Booked
|
settings.feedShowBooked | boolean |
Indicates if the feed shows booked times |
Language Setting
|
settings.languageSetting | string |
Language setting of the user (e.g., 'en-US') |
Time Zone
|
settings.timeZone | string |
Time zone of the user (e.g., 'Europe/Amsterdam') |
24h Time Format
|
settings.timeFormat24h | boolean |
Indicates if the user prefers a 24-hour time format |
Date Format
|
settings.dateFormat | string |
Preferred date format of the user |
Theme
|
settings.theme | string |
UI theme setting for the user |
Rounding Enabled
|
settings.rounding.enabled | boolean |
Indicates if time rounding is enabled |
Rounding Minutes
|
settings.rounding.minutes | integer |
Number of minutes for rounding |
Rounding Type
|
settings.rounding.type | integer |
Type of rounding (e.g., 0 for nearest) |
Organization Name
|
organization.displayName | string |
Name of the organization |
enabledGraphScopes
|
enabledGraphScopes | array of string | |
apiTokens
|
apiTokens | array of object | |
Token Name
|
apiTokens.name | string |
Name of the API token |
Token
|
apiTokens.token | string |
API token value |
pinnedProjects
|
pinnedProjects | array of object | |
Project ID
|
pinnedProjects.id | string |
Unique ID of the pinned project |
Project Name
|
pinnedProjects.name | string |
Name of the pinned project |
Display Name
|
officeProfile.displayName | string |
User's display name in the office profile |
Email
|
officeProfile.mail | string |
Email address in the office profile |
User Principal Name
|
officeProfile.userPrincipalName | string |
User principal name in the office profile |
WorkspaceResponse
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
Unique ID of the workspace |
Name
|
name | string |
Workspace name |
Description
|
description | string |
Workspace description |
Deleted
|
deleted | boolean |
Indicates whether the workspace is marked as deleted |
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 default currency of this workspace |
Future time tracking allowed?
|
settings.allowFutureTimeTracking | boolean |
Indicates if future time tracking is allowed |
Allow Time Overlap
|
settings.allowTimeOverlap | boolean |
Indicates if overlapping time entries are allowed |
Comego Enabled
|
settings.comego | boolean |
Indicates if Comego is enabled for the workspace |
Comego Only
|
settings.comegoOnly | boolean |
Indicates if only Comego tracking is enabled |
Times Mode
|
settings.timesMode | string |
Mode for time tracking (e.g., 'range') |
Subscription Status
|
subscription.status | string |
The status of the workspace subscription (e.g., 'active', 'trial') |
Subscription End
|
subscription.end | date-time |
The end time of the subscription |
Quantity
|
subscription.quantity | double |
The number of licenses in this workspace |
Provider
|
subscription.provider | string |
The provider of the subscription (e.g., 'paddle') |
Recurring Interval
|
subscription.recurringInterval | string |
The recurring interval of the subscription |
Currency
|
subscription.currency | string |
The currency used in the subscription |
users
|
users | array of object | |
User ID
|
users.id | string |
Unique ID of the user |
Name
|
users.name | string |
User's name |
Email
|
users.email | string |
User's email address |
Is Admin
|
users.admin | boolean |
Indicates if the user has admin privileges |
Billable 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 |
Has License
|
users.has_license | boolean |
Indicates if the user has a license in the workspace |
Removed
|
users.removed | boolean |
Indicates if the user is removed from the workspace |
groups
|
groups | array of object | |
Group ID
|
groups.id | string |
Unique ID of the group |
Group Name
|
groups.name | string |
Name of the group |
Synchronized Group
|
groups.synchronizedGroup | boolean |
Indicates if the group is synchronized |
Synchronized Group Type
|
groups.synchronizedGroupType | string |
Type of synchronized group (e.g., 'teams') |
users
|
groups.users | array of object | |
User ID
|
groups.users.id | string |
Unique ID of the user |
User Name
|
groups.users.name | string |
Name of the user in the group |
groupsCanManageProjects
|
permissionSettings.groupsCanManageProjects | array of object | |
Group ID
|
permissionSettings.groupsCanManageProjects.id | string |
Unique ID of the group |
groupsCanSeeTeamActivity
|
permissionSettings.groupsCanSeeTeamActivity | array of object | |
Group ID
|
permissionSettings.groupsCanSeeTeamActivity.id | string |
Unique ID of the group |
projectPermissions
|
projectPermissions | array of object | |
Project ID
|
projectPermissions.projectId | string |
Unique ID of the project |
Private
|
projectPermissions.private | boolean |
Indicates if the project is private |
users
|
projectPermissions.users | array of object | |
User ID
|
projectPermissions.users.id | string |
Unique ID of the user |
Role
|
projectPermissions.users.role | number |
Role of the user in the project |
groups
|
projectPermissions.groups | array of object | |
Group ID
|
projectPermissions.groups.id | string |
Unique ID of the group |
Role
|
projectPermissions.groups.role | number |
Role of the group in the project |
webhooks
|
webhooks | array of object | |
Webhook Name
|
webhooks.name | string |
Name of the webhook |
Entity
|
webhooks.entity | string |
Entity that the webhook is attached to |
Active
|
webhooks.active | boolean |
Indicates if the webhook is active |
Can Edit
|
currentUserCanEdit | boolean |
Indicates if the current user can edit the workspace |
ComeGoResponse
Name | Path | Type | Description |
---|---|---|---|
id
|
id | string |
Unique ID of the ComeGo entry |
cosmosEntityName
|
cosmosEntityName | string |
Entity name in the database |
deleted
|
deleted | boolean |
Indicates whether the entry is marked as deleted |
editor
|
editor | string |
ID of the editor who last modified the entry |
modified
|
modified | date-time |
Timestamp when the entry was last modified |
author
|
author | string |
ID of the author who created the entry |
created
|
created | date-time |
Timestamp when the entry was created |
status
|
status | string |
Status of the entry (e.g., 'new') |
partitionKey
|
partitionKey | string |
Partition key for the entry in the database |
name
|
name | string |
Optional name for the entry |
start
|
start | date-time |
Start time of the entry |
end
|
end | date-time |
End time of the entry, if applicable |
type
|
type | string |
Type of entry (e.g., 'work', 'break') |
id
|
user.id | string |
Unique ID of the user |
name
|
user.name | string |
Name of the user |
tags
|
tags | array of string |
Tags associated with the entry |
timeZone
|
timeZone | string |
Time zone of the entry |
id
|
workspace.id | string |
Unique ID of the workspace |
currentUserCanEdit
|
currentUserCanEdit | boolean |
Indicates if the current user has permission to edit the entry |
object
This is the type 'object'.