{ "opencollection": "1.0.0", "info": { "name": "Clockify API", "version": "v1" }, "items": [ { "info": { "name": "User", "type": "folder" }, "items": [ { "info": { "name": "Add a photo", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/file/image", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Add a photo" }, { "info": { "name": "Get currently logged-in user's info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/user", "params": [ { "name": "include-memberships", "value": "true", "type": "query", "description": "If set to true, memberships will be included." } ], "auth": { "type": "apikey", "key": "x-marketplace-token", "value": "{{x-marketplace-token}}", "placement": "header" } }, "docs": "Get currently logged-in user's info" }, { "info": { "name": "Get a member's profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/member-profile/:userId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get a member's profile" }, { "info": { "name": "Update a member's profile", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/member-profile/:userId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a member's profile" }, { "info": { "name": "Find all users on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/users", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "email", "value": "mail@example.com", "type": "query", "description": "If provided, you'll get a filtered list of users that contain the provided string in their email address." }, { "name": "project-id", "value": "21a687e29ae1f428e7ebe606", "type": "query", "description": "If provided, you'll get a list of users that have access to the project." }, { "name": "status", "value": "ACTIVE", "type": "query", "description": "If provided, you'll get a filtered list of users with the corresponding status." }, { "name": "account-statuses", "value": "LIMITED", "type": "query", "description": "If provided, you'll get a filtered list of users with the corresponding account status filter. If not, this will only filter ACTIVE, PENDING_EMAIL_VERIFICATION, and NOT_REGISTERED Users." }, { "name": "name", "value": "John", "type": "query", "description": "If provided, you'll get a filtered list of users that contain the provided string in their name" }, { "name": "sort-column", "value": "ID", "type": "query", "description": "Sorting column criteria. Default value: EMAIL" }, { "name": "sort-order", "value": "ASCENDING", "type": "query", "description": "Sorting mode. Default value: ASCENDING" }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." }, { "name": "memberships", "value": "WORKSPACE", "type": "query", "description": "If provided, you'll get all users along with workspaces, groups, or projects they have access to. Default value is NONE." }, { "name": "include-roles", "value": "", "type": "query", "description": "If you pass along includeRoles=true, you'll get each user's detailed manager role (including projects and members which they manage)" } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Find all users on a workspace" }, { "info": { "name": "Filter workspace users", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/users/info", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-marketplace-token", "value": "{{x-marketplace-token}}", "placement": "header" } }, "docs": "Filter workspace users" }, { "info": { "name": "Update a user's custom field", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/users/:userId/custom-field/:customFieldId/value", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." }, { "name": "customFieldId", "value": "5e4117fe8c625f38930d57b7", "type": "path", "description": "Represents custom field identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a user's custom field" }, { "info": { "name": "Find user's team manager", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/users/:userId/managers", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." }, { "name": "sort-column", "value": "ID", "type": "query", "description": "Sorting column criteria" }, { "name": "sort-order", "value": "ASCENDING", "type": "query", "description": "Sorting mode" }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Find user's team manager" }, { "info": { "name": "Give manager role to a user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/users/:userId/roles", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Give manager role to a user" }, { "info": { "name": "Remove user's manager role", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/users/:userId/roles", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Remove user's manager role" } ] }, { "info": { "name": "Workspace", "type": "folder" }, "items": [ { "info": { "name": "Get all my workspaces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces", "params": [ { "name": "roles", "value": "WORKSPACE_ADMIN,OWNER", "type": "query", "description": "If provided, you'll get a filtered list of workspaces where you have any of the specified roles. Owners are not counted as admins when filtering." } ], "auth": { "type": "apikey", "key": "x-marketplace-token", "value": "{{x-marketplace-token}}", "placement": "header" } }, "docs": "Get all my workspaces" }, { "info": { "name": "Add a workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Add a workspace" }, { "info": { "name": "Get workspace info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get workspace info" }, { "info": { "name": "Update workspace cost rate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/cost-rate", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update workspace cost rate" }, { "info": { "name": "Update workspace billable rate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/hourly-rate", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update workspace billable rate" }, { "info": { "name": "Add user to a workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/users", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "send-email", "value": "", "type": "query", "description": "Indicates whether to send an email when user is added to the workspace." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "You can add users to a workspace via API only if that workspace has a paid subscription. If the workspace has a paid subscription, you can add as many users as you want but you are limited by the number of paid user seats on that workspace." }, { "info": { "name": "Update a user's status", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/users/:userId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "89b687e29ae1f428e7ebe912", "type": "path", "description": "Represents a user identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a user's status" }, { "info": { "name": "Update a user's cost rate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/users/:userId/cost-rate", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "89b687e29ae1f428e7ebe912", "type": "path", "description": "Represents a user identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a user's cost rate" }, { "info": { "name": "Update a user's hourly rate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/users/:userId/hourly-rate", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "89b687e29ae1f428e7ebe912", "type": "path", "description": "Represents a user identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a user's hourly rate" } ] }, { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "Get all webhooks for addon on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/addons/:addonId/webhooks", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "addonId", "value": "64c777ddd3fcab07cfbb210c", "type": "path", "description": "Represents an addon identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get all webhooks for addon on a workspace" }, { "info": { "name": "Get all webhooks on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/webhooks", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "type", "value": "USER_CREATED", "type": "query", "description": "Represents a webhook type." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get all webhooks on a workspace" }, { "info": { "name": "Create a webhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/webhooks", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Creating a webhook generates a new token which can be used to verify that the webhook being sent was sent by Clockify, as it will always be present in the header." }, { "info": { "name": "Get a specific webhook by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/webhooks/:webhookId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "webhookId", "value": "5b715448b0798751107918ab", "type": "path", "description": "Represents a webhook identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get a specific webhook by id" }, { "info": { "name": "Update a webhook", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/webhooks/:webhookId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "webhookId", "value": "5b715448b0798751107918ab", "type": "path", "description": "Represents a webhook identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a webhook" }, { "info": { "name": "Delete a webhook", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/webhooks/:webhookId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "webhookId", "value": "5b715448b0798751107918ab", "type": "path", "description": "Represents a webhook identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete a webhook" }, { "info": { "name": "Get logs for a webhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/webhooks/:webhookId/logs", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "webhookId", "value": "", "type": "path", "description": "Represents a webhook identifier across the system." }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "size", "value": "50", "type": "query", "description": "Page size." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get logs for a webhook" }, { "info": { "name": "Generate a new token", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/webhooks/:webhookId/token", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "webhookId", "value": "5b715448b0798751107918ab", "type": "path", "description": "Represents a webhook identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Generates a new webhook token and invalidates previous one" } ] }, { "info": { "name": "Approval", "type": "folder" }, "items": [ { "info": { "name": "Get approval requests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/approval-requests", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "status", "value": "PENDING", "type": "query", "description": "Filters results based on the provided approval state." }, { "name": "sort-column", "value": "START", "type": "query", "description": "Represents the column name to be used as sorting criteria." }, { "name": "sort-order", "value": "ASCENDING", "type": "query", "description": "Represents the sorting order." }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get approval requests" }, { "info": { "name": "Submit approval request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/approval-requests", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Submit approval request" }, { "info": { "name": "Submit non pending/approved entries/expenses for approval to an existing approval request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/approval-requests/resubmit-entries-for-approval", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Submit non pending/approved entries/expenses for approval to an existing approval request" }, { "info": { "name": "Submit an approval request for a user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/approval-requests/users/:userId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Submit an approval request for a user" }, { "info": { "name": "Re-submit rejected/withdrawn entries/expenses for an approval of a user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/approval-requests/users/:userId/resubmit-entries-for-approval", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Re-submit rejected/withdrawn entries/expenses for an approval of a user" }, { "info": { "name": "Update an approval request", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/approval-requests/:approvalRequestId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "approvalRequestId", "value": "940ab5acb07987125438b65y", "type": "path", "description": "Represents an approval request identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update an approval request" } ] }, { "info": { "name": "Client", "type": "folder" }, "items": [ { "info": { "name": "Find clients on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/clients", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "name", "value": "Client X", "type": "query", "description": "Filters client results that matches with the string provided in their client name." }, { "name": "sort-column", "value": "NAME", "type": "query", "description": "Column name that will be used as criteria for sorting results." }, { "name": "sort-order", "value": "ASCENDING", "type": "query", "description": "Sorting mode" }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." }, { "name": "archived", "value": "false", "type": "query", "description": "Filter whether to include archived clients or not." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Find clients on a workspace" }, { "info": { "name": "Add a new client", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/clients", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Add a new client" }, { "info": { "name": "Get a client by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/clients/:id", "params": [ { "name": "id", "value": "44a687e29ae1f428e7ebe305", "type": "path", "description": "Represents a client identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get a client by ID" }, { "info": { "name": "Update a client", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/clients/:id", "params": [ { "name": "id", "value": "44a687e29ae1f428e7ebe305", "type": "path", "description": "Represents a client identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "archive-projects", "value": "", "type": "query" }, { "name": "mark-tasks-as-done", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a client" }, { "info": { "name": "Delete a client", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/clients/:id", "params": [ { "name": "id", "value": "44a687e29ae1f428e7ebe305", "type": "path", "description": "Represents a client identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete a client" } ] }, { "info": { "name": "Custom fields", "type": "folder" }, "items": [ { "info": { "name": "Get custom fields on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/custom-fields", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "name", "value": "location", "type": "query", "description": "If provided, you'll get a filtered list of custom fields that contain the provided string in their name." }, { "name": "status", "value": "VISIBLE", "type": "query", "description": "If provided, you'll get a filtered list of custom fields that matches the provided string with the custom field status." }, { "name": "entity-type", "value": "TIMEENTRY,USER", "type": "query", "description": "If provided, you'll get a filtered list of custom fields that matches the provided string with the custom field entity type." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get custom fields on a workspace" }, { "info": { "name": "Create custom fields on a workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/custom-fields", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Create custom fields on a workspace" }, { "info": { "name": "Update custom field on workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/custom-fields/:customFieldId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "customFieldId", "value": "26a687e29ae1f428e7ebe101", "type": "path", "description": "Represents a custom field identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update custom field on workspace" }, { "info": { "name": "Delete a custom field", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/custom-fields/:customFieldId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents workspace identifier across the system." }, { "name": "customFieldId", "value": "26a687e29ae1f428e7ebe101", "type": "path", "description": "Represents custom field identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete a custom field" }, { "info": { "name": "Get custom fields on a project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/custom-fields", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "5b641568b07987035750505e", "type": "path", "description": "Represents a project identifier across the system." }, { "name": "status", "value": "INACTIVE", "type": "query", "description": "If provided, you'll get a filtered list of custom fields that matches the provided string with the custom field status." }, { "name": "entity-type", "value": "TIMEENTRY", "type": "query", "description": "If provided, you'll get a filtered list of custom fields that matches the provided string with the custom field entity type." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get custom fields on a project" }, { "info": { "name": "Update custom field on a project", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/custom-fields/:customFieldId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a project identifier across the system." }, { "name": "customFieldId", "value": "26a687e29ae1f428e7ebe101", "type": "path", "description": "Represents a custom field identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update custom field on a project" }, { "info": { "name": "Remove custom field from a project", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/custom-fields/:customFieldId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a project identifier across the system." }, { "name": "customFieldId", "value": "26a687e29ae1f428e7ebe101", "type": "path", "description": "Represents a custom field identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Remove custom field from a project" } ] }, { "info": { "name": "Entity changes (Experimental)", "type": "folder" }, "items": [ { "info": { "name": "Created entities (Experimental)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/entities/created", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents workspace identifier across the system." }, { "name": "type", "value": "TIME_ENTRY", "type": "query", "description": "Specifies the type of document to be retrieved. Expected values are CLIENTS, PROJECTS, TAGS, TASKS, SCHEDULED_ASSIGNMENT, TIME_ENTRY, TIME_ENTRY_RATE, TIME_ENTRY_CUSTOM_FIELD_VALUE.This parameter can accept multiple values, and at least one option must be provided. Based on the input, the application will return results corresponding to the selected document types." }, { "name": "start", "value": "2024-10-29T10:00:00Z", "type": "query", "description": "Represents the start date in yyyy-MM-ddThh:mm:ssZ format. This parameter is optional; if no start date is provided, the application will set a default start date that matches the end date to create a date range of 30 days. If the end date is not specified either, the default behavior will apply from the current date." }, { "name": "end", "value": "2024-11-28T10:00:00Z", "type": "query", "description": "Represents the end date in yyyy-MM-ddThh:mm:ssZ format. This parameter is optional; if no end date is provided, the application will set a default end date that matches the start date to create a date range of 30 days." }, { "name": "page", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Retrieves records from the database collection that were created within a specified date range. \nThe date range is determined by two parameters: start and end. " }, { "info": { "name": "Deleted entities (Experimental)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/entities/deleted", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents workspace identifier across the system (Experimental) " }, { "name": "type", "value": "TIME_ENTRY", "type": "query", "description": "Specifies the type of document to be retrieved. Expected values are CLIENTS, PROJECTS, TAGS, TASKS, SCHEDULED_ASSIGNMENT, TIME_ENTRY, TIME_ENTRY_RATE, TIME_ENTRY_CUSTOM_FIELD_VALUE.This parameter can accept multiple values, and at least one option must be provided. Based on the input, the application will return results corresponding to the selected document types." }, { "name": "start", "value": "2024-10-29T10:00:00Z", "type": "query", "description": "Represents the start date in yyyy-MM-ddThh:mm:ssZ format. This parameter is optional; if no start date is provided, the application will set a default start date that matches the end date to create a date range of 30 days. If the end date is not specified either, the default behavior will apply from the current date." }, { "name": "end", "value": "2024-11-28T10:00:00Z", "type": "query", "description": "Represents the end date in yyyy-MM-ddThh:mm:ssZ format. This parameter is optional; if no end date is provided, the application will set a default end date that matches the start date to create a date range of 30 days." }, { "name": "page", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Retrieves a list of record(s) that were deleted within a specified date range. \nThe date range is determined by the two parameters start and end. \n\n> ### 💡 Note\n> Deleted entities will be updated and reflected in this endpoint approximately one minute after the deletion occurs. Also, entities that are created and deleted within the request date range will not appear in the /deleted endpoint. " }, { "info": { "name": "Updated entities (Experimental)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/entities/updated", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents workspace identifier across the system." }, { "name": "type", "value": "TIME_ENTRY", "type": "query", "description": "Specifies the type of document to be retrieved. Expected values are CLIENTS, PROJECTS, TAGS, TASKS, SCHEDULED_ASSIGNMENT, TIME_ENTRY, TIME_ENTRY_RATE, TIME_ENTRY_CUSTOM_FIELD_VALUE.This parameter can accept multiple values, and at least one option must be provided. Based on the input, the application will return results corresponding to the selected document types." }, { "name": "start", "value": "2024-10-29T10:00:00Z", "type": "query", "description": "Represents the start date in yyyy-MM-ddThh:mm:ssZ format. This parameter is optional; if no start date is provided, the application will set a default start date that matches the end date to create a date range of 30 days. If the end date is not specified either, the default behavior will apply from the current date." }, { "name": "end", "value": "2024-11-28T10:00:00Z", "type": "query", "description": "Represents the end date in yyyy-MM-ddThh:mm:ssZ format. This parameter is optional; if no end date is provided, the application will set a default end date that matches the start date to create a date range of 30 days." }, { "name": "page", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Retrieves records that were updated within the specified date range. \nThe date range is determined by the two parameters: start and end. \n\n> ### 💡 Note\n> If an entity is both created and updated within the requested date range, it will be excluded from the /updated endpoint results. " } ] }, { "info": { "name": "Expense", "type": "folder" }, "items": [ { "info": { "name": "Get all expenses on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/expenses", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." }, { "name": "user-id", "value": "5a0ab5acb07987125438b60f", "type": "query", "description": "If provided, you'll get a filtered list of expenses which match the provided string in the user ID linked to the expense." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get all expenses on a workspace" }, { "info": { "name": "Create an expense", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/expenses", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Create an expense" }, { "info": { "name": "Get all expense categories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/expenses/categories", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "sort-column", "value": "NAME", "type": "query", "description": "Represents the column name to be used as sorting criteria." }, { "name": "sort-order", "value": "ASCENDING", "type": "query", "description": "Represents the sorting order." }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." }, { "name": "archived", "value": "true", "type": "query", "description": "Flag to filter results based on whether category is archived or not." }, { "name": "name", "value": "procurement", "type": "query", "description": "If provided, you'll get a filtered list of expense categories that matches the provided string in their name." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get all expense categories" }, { "info": { "name": "Add an expense category", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/expenses/categories", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Add an expense category" }, { "info": { "name": "Update an expense category", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/expenses/categories/:categoryId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "categoryId", "value": "89a687e29ae1f428e7ebe567", "type": "path", "description": "Represents a category identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update an expense category" }, { "info": { "name": "Delete an expense category", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/expenses/categories/:categoryId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "categoryId", "value": "89a687e29ae1f428e7ebe567", "type": "path", "description": "Represents a category identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete an expense category" }, { "info": { "name": "Archive an expense category", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/expenses/categories/:categoryId/status", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "categoryId", "value": "89a687e29ae1f428e7ebe567", "type": "path", "description": "Represents a category identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Archive an expense category" }, { "info": { "name": "Get an expense by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/expenses/:expenseId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "expenseId", "value": "64c777ddd3fcab07cfbb210c", "type": "path", "description": "Represents an expense identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get an expense by ID" }, { "info": { "name": "Update an expense", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/expenses/:expenseId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "expenseId", "value": "64c777ddd3fcab07cfbb210c", "type": "path", "description": "Represents an expense identifier across the system." } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update an expense" }, { "info": { "name": "Delete an expense", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/expenses/:expenseId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "expenseId", "value": "64c777ddd3fcab07cfbb210c", "type": "path", "description": "Represents an expense identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete an expense" }, { "info": { "name": "Download a receipt", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/expenses/:expenseId/files/:fileId", "params": [ { "name": "fileId", "value": "745687e29ae1f428e7ebe890", "type": "path", "description": "Represents a file identifier across the system." }, { "name": "expenseId", "value": "64c777ddd3fcab07cfbb210c", "type": "path", "description": "Represents an expense identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Download a receipt" } ] }, { "info": { "name": "Holiday", "type": "folder" }, "items": [ { "info": { "name": "Get holidays on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/holidays", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "assigned-to", "value": "60f924bafdaf031696ec6218", "type": "query", "description": "If provided, you'll get a filtered list of holidays assigned to user." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get holidays on a workspace" }, { "info": { "name": "Create a holiday", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/holidays", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Create a holiday" }, { "info": { "name": "Get holidays in a specific period", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/holidays/in-period", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "assigned-to", "value": "60f924bafdaf031696ec6218", "type": "query", "description": "Filter list of holidays assigned to user." }, { "name": "start", "value": "2022-12-03T10:59:59.999Z", "type": "query", "description": "Filter list of holidays starting from start date. Expected date format yyyy-MM-ddThh:mm:ssZ" }, { "name": "end", "value": "2022-12-05T23:59:59.999Z", "type": "query", "description": "Filter list of holidays ending by end date. Expected date format yyyy-MM-ddThh:mm:ssZ" } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get holidays in a specific period" }, { "info": { "name": "Update a holiday", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/holidays/:holidayId", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "holidayId", "value": "60f927920658241e3cf35e02", "type": "path", "description": "Represents a holiday identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a holiday" }, { "info": { "name": "Delete a holiday", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/holidays/:holidayId", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "holidayId", "value": "60f927920658241e3cf35e02", "type": "path", "description": "Represents a holiday identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete a holiday" } ] }, { "info": { "name": "Invoice", "type": "folder" }, "items": [ { "info": { "name": "Get all invoices on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." }, { "name": "statuses", "value": "UNSENT,PAID", "type": "query", "description": "If provided, you'll get a filtered result of invoices that matches the provided string in the user ID linked to the expense." }, { "name": "sort-column", "value": "CLIENT", "type": "query", "description": "Valid column name as sorting criteria. Default: ID" }, { "name": "sort-order", "value": "ASCENDING", "type": "query", "description": "Sort order. Default: ASCENDING" } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get all invoices on a workspace" }, { "info": { "name": "Add an invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Add an invoice" }, { "info": { "name": "Filter out invoices", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/info", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Filter out invoices" }, { "info": { "name": "Get an invoice in another language", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/settings", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get an invoice in another language" }, { "info": { "name": "Change an invoice language", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/settings", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Change an invoice language" }, { "info": { "name": "Get an invoice by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/:invoiceId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "invoiceId", "value": "83q687e29ae1f428e7ebe195", "type": "path", "description": "Represents an invoice identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get an invoice by ID" }, { "info": { "name": "Update an invoice", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/:invoiceId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "invoiceId", "value": "78a687e29ae1f428e7ebe303", "type": "path", "description": "Represents an invoice identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update an invoice" }, { "info": { "name": "Delete an invoice", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/:invoiceId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "invoiceId", "value": "78a687e29ae1f428e7ebe303", "type": "path", "description": "Represents an invoice identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete an invoice" }, { "info": { "name": "Duplicate an invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/:invoiceId/duplicate", "params": [ { "name": "invoiceId", "value": "78a687e29ae1f428e7ebe303", "type": "path", "description": "Represents an invoice identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Duplicate an invoice" }, { "info": { "name": "Export an invoice", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/:invoiceId/export", "params": [ { "name": "invoiceId", "value": "78a687e29ae1f428e7ebe303", "type": "path", "description": "Represents an invoice identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userLocale", "value": "en", "type": "query", "description": "Represents a locale." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Export an invoice" }, { "info": { "name": "Add item to an invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/:invoiceId/items", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "invoiceId", "value": "83q687e29ae1f428e7ebe195", "type": "path", "description": "Represents an invoice identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Add item to an invoice" }, { "info": { "name": "Import time entries and expenses to an invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/:invoiceId/items/import", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "invoiceId", "value": "83q687e29ae1f428e7ebe195", "type": "path", "description": "Represents an invoice identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Import time entries and expenses to an invoice" }, { "info": { "name": "Delete item from an invoice", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/:invoiceId/items/:order", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "invoiceId", "value": "83q687e29ae1f428e7ebe195", "type": "path", "description": "Represents an invoice identifier across the system." }, { "name": "order", "value": "3", "type": "path", "description": "Represents an invoice item order." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete item from an invoice" }, { "info": { "name": "Get payments for an invoice", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/:invoiceId/payments", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "invoiceId", "value": "78a687e29ae1f428e7ebe303", "type": "path", "description": "Represents an invoice identifier across the system." }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get payments for an invoice" }, { "info": { "name": "Add payment to an invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/:invoiceId/payments", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "invoiceId", "value": "78a687e29ae1f428e7ebe303", "type": "path", "description": "Represents an invoice identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Add payment to an invoice" }, { "info": { "name": "Delete payment from an invoice", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/:invoiceId/payments/:paymentId", "params": [ { "name": "invoiceId", "value": "78a687e29ae1f428e7ebe303", "type": "path", "description": "Represents an invoice identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "paymentId", "value": "56p687e29ae1f428e7ebe456", "type": "path", "description": "Represents a payment identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete payment from an invoice" }, { "info": { "name": "Change an invoice status", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/invoices/:invoiceId/status", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "invoiceId", "value": "78a687e29ae1f428e7ebe303", "type": "path", "description": "Represents an invoice identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Change an invoice status" } ] }, { "info": { "name": "Project", "type": "folder" }, "items": [ { "info": { "name": "Get all projects on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "name", "value": "Software Development", "type": "query", "description": "If provided, you'll get a filtered list of projects that contains the provided string in the project name." }, { "name": "strict-name-search", "value": "", "type": "query", "description": "Flag to toggle on/off strict search mode. When set to true, search by name will only return projects whose name exactly matches the string value given for the 'name' parameter. When set to false, results will also include projects whose name contain the string value, but could be longer than the string value itself. For example, if there is a project with the name 'applications', and the search value is 'app', setting strict-name-search to true will not return that project in the results, whereas setting it to false will." }, { "name": "archived", "value": "", "type": "query", "description": "If provided and set to true, you'll only get archived projects. If omitted, you'll get both archived and non-archived projects." }, { "name": "billable", "value": "", "type": "query", "description": "If provided and set to true, you'll only get billable projects. If omitted, you'll get both billable and non-billable projects." }, { "name": "clients", "value": "5a0ab5acb07987125438b60f,64c777ddd3fcab07cfbb210c", "type": "query", "description": "If provided, you'll get a filtered list of projects that contain clients which match any of the provided ids." }, { "name": "contains-client", "value": "", "type": "query", "description": "If set to true, you'll get a filtered list of projects that contain clients which match the provided id(s) in 'clients' field. If set to false, you'll get a filtered list of projects which do NOT contain clients that match the provided id(s) in 'clients' field." }, { "name": "client-status", "value": "ACTIVE", "type": "query", "description": "Filters projects based on client status provided." }, { "name": "users", "value": "5a0ab5acb07987125438b60f,64c777ddd3fcab07cfbb210c", "type": "query", "description": "If provided, you'll get a filtered list of projects that contain users which match any of the provided ids." }, { "name": "contains-user", "value": "", "type": "query", "description": "If set to true, you'll get a filtered list of projects that contain users which match the provided id(s) in 'users' field. If set to false, you'll get a filtered list of projects which do NOT contain users which match the provided id(s) in 'users' field." }, { "name": "user-status", "value": "ALL", "type": "query", "description": "Filters projects based on user status provided." }, { "name": "is-template", "value": "", "type": "query", "description": "Filters projects based on whether they are used as a template or not." }, { "name": "sort-column", "value": "NAME", "type": "query", "description": "Sorts the results by the given column/field." }, { "name": "sort-order", "value": "ASCENDING", "type": "query", "description": "Sorting mode." }, { "name": "hydrated", "value": "", "type": "query", "description": "If set to true, results will contain additional information about the project." }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." }, { "name": "access", "value": "PUBLIC", "type": "query", "description": "Valid set of string(s). If provided, you'll get a filtered list of projects that matches the provided access." }, { "name": "expense-limit", "value": "10", "type": "query", "description": "Represents the maximum number of expenses to fetch." }, { "name": "expense-date", "value": "2024-12-31", "type": "query", "description": "If provided, you will get expenses dated before the provided value in yyyy-MM-dd format." }, { "name": "userGroups", "value": "5a0ab5acb07987125438b60f,64c777ddd3fcab07cfbb210c", "type": "query", "description": "If provided, you'll get a filtered list of projects that contain groups which match any of the provided ids." }, { "name": "contains-group", "value": "", "type": "query", "description": "If set to true, you'll get a filtered list of projects that contain groups which match the provided id(s) in 'userGroups' field. If set to false, you'll get a filtered list of projects which do NOT contain groups which match the provided id(s) in 'userGroups' field." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get all projects on a workspace" }, { "info": { "name": "Add a new project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Add a new project" }, { "info": { "name": "Create project from a template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/from-template", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Create project from a template" }, { "info": { "name": "Find a project by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "5b641568b07987035750505e", "type": "path", "description": "Represents a project identifier across the system." }, { "name": "hydrated", "value": "", "type": "query", "description": "If set to true, results will contain additional information about the project" }, { "name": "custom-field-entity-type", "value": "TIMEENTRY", "type": "query", "description": "If provided, you'll get a filtered list of custom fields that matches the provided string with the custom field entity type." }, { "name": "expense-limit", "value": "10", "type": "query", "description": "Represents the maximum number of expenses to fetch." }, { "name": "expense-date", "value": "2024-12-31", "type": "query", "description": "If provided, you will get expenses dated before the provided value in yyyy-MM-dd format." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Find a project by ID" }, { "info": { "name": "Update a project on a workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "5b641568b07987035750505e", "type": "path", "description": "Represents a project identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a project on a workspace" }, { "info": { "name": "Delete a project from a workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "5b641568b07987035750505e", "type": "path", "description": "Represents a project identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete a project from a workspace" }, { "info": { "name": "Update project estimate", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/estimate", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "5b641568b07987035750505e", "type": "path", "description": "Represents a project identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update project estimate" }, { "info": { "name": "Assign/remove users to/from the project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/memberships", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "5b641568b07987035750505e", "type": "path", "description": "Represents a project identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Assign/remove users to/from the project" }, { "info": { "name": "Update project memberships", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/memberships", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "5b641568b07987035750505e", "type": "path", "description": "Represents a project identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update project memberships" }, { "info": { "name": "Update a project template", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/template", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "5b641568b07987035750505e", "type": "path", "description": "Represents a project identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a project template" }, { "info": { "name": "Update project user's cost rate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/users/:userId/cost-rate", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "5b641568b07987035750505e", "type": "path", "description": "Represents a project identifier across the system." }, { "name": "userId", "value": "4a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update project user's cost rate" }, { "info": { "name": "Update a project user's billable rate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/users/:userId/hourly-rate", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "5b641568b07987035750505e", "type": "path", "description": "Represents a project identifier across the system." }, { "name": "userId", "value": "4a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a project user's billable rate" } ] }, { "info": { "name": "Task", "type": "folder" }, "items": [ { "info": { "name": "Find tasks on a project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/tasks", "params": [ { "name": "projectId", "value": "25b687e29ae1f428e7ebe123", "type": "path", "description": "Represents a project identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "name", "value": "Bugfixing", "type": "query", "description": "If provided, you'll get a filtered list of tasks that matches the provided string in their name." }, { "name": "strict-name-search", "value": "", "type": "query", "description": "Flag to toggle on/off strict search mode. When set to true, search by name only will return tasks whose name exactly matches the string value given for the 'name' parameter. When set to false, results will also include tasks whose name contain the string value, but could be longer than the string value itself. For example, if there is a task with the name 'applications', and the search value is 'app', setting strict-name-search to true will not return that task in the results, whereas setting it to false will." }, { "name": "is-active", "value": "", "type": "query", "description": "Filters search results whether task is active or not." }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." }, { "name": "sort-column", "value": "ID", "type": "query", "description": "Represents the column as criteria for sorting tasks." }, { "name": "sort-order", "value": "ASCENDING", "type": "query", "description": "Sorting mode." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Find tasks on a project" }, { "info": { "name": "Add a new task on a project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/tasks", "params": [ { "name": "projectId", "value": "25b687e29ae1f428e7ebe123", "type": "path", "description": "Represents a project identifier across the system." }, { "name": "contains-assignee", "value": "", "type": "query", "description": "Flag to set whether task will have assignee or none." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Add a new task on a project" }, { "info": { "name": "Update a task's cost rate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/tasks/:id/cost-rate", "params": [ { "name": "projectId", "value": "25b687e29ae1f428e7ebe123", "type": "path", "description": "Represents a project identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "id", "value": "57a687e29ae1f428e7ebe107", "type": "path", "description": "Represents a task identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a task's cost rate" }, { "info": { "name": "Update a task's billable rate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/tasks/:id/hourly-rate", "params": [ { "name": "projectId", "value": "25b687e29ae1f428e7ebe123", "type": "path", "description": "Represents a project identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "id", "value": "57a687e29ae1f428e7ebe107", "type": "path", "description": "Represents a task identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a task's billable rate" }, { "info": { "name": "Get a task by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/tasks/:taskId", "params": [ { "name": "taskId", "value": "57a687e29ae1f428e7ebe107", "type": "path", "description": "Represents a task identifier across the system." }, { "name": "projectId", "value": "25b687e29ae1f428e7ebe123", "type": "path", "description": "Represents a project identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get a task by id" }, { "info": { "name": "Update a task on a project", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/tasks/:taskId", "params": [ { "name": "taskId", "value": "57a687e29ae1f428e7ebe107", "type": "path", "description": "Represents a task identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "25b687e29ae1f428e7ebe123", "type": "path", "description": "Represents a project identifier across the system." }, { "name": "contains-assignee", "value": "", "type": "query", "description": "Flag to set whether task will have assignee or none." }, { "name": "membership-status", "value": "ACTIVE", "type": "query", "description": "Represents a membership status." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a task on a project" }, { "info": { "name": "Delete a task from a project", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/projects/:projectId/tasks/:taskId", "params": [ { "name": "taskId", "value": "57a687e29ae1f428e7ebe107", "type": "path", "description": "Represents a task identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "25b687e29ae1f428e7ebe123", "type": "path", "description": "Represents a project identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete a task from a project" } ] }, { "info": { "name": "Scheduling", "type": "folder" }, "items": [ { "info": { "name": "Get all assignments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/scheduling/assignments/all", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "name", "value": "Bugfixing", "type": "query", "description": "If provided, assignments will be filtered by name" }, { "name": "start", "value": "2020-01-01T00:00:00Z", "type": "query", "description": "Represents a start date in the yyyy-MM-ddThh:mm:ssZ format." }, { "name": "end", "value": "2021-01-01T00:00:00Z", "type": "query", "description": "Represents a start date in the yyyy-MM-ddThh:mm:ssZ format." }, { "name": "sort-column", "value": "USER", "type": "query", "description": "Represents the column as the sorting criteria." }, { "name": "sort-order", "value": "ASCENDING", "type": "query", "description": "Represents the sorting mode." }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get all assignments" }, { "info": { "name": "Get all scheduled assignments per project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/scheduling/assignments/projects/totals", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get all scheduled assignments per project" }, { "info": { "name": "Get all scheduled assignments on project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/scheduling/assignments/projects/totals/:projectId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "projectId", "value": "56b687e29ae1f428e7ebe504", "type": "path", "description": "Represents a project identifier across the system." }, { "name": "start", "value": "2020-01-01T00:00:00Z", "type": "query", "description": "Represents a start date in the yyyy-MM-ddThh:mm:ssZ format." }, { "name": "end", "value": "2021-01-01T00:00:00Z", "type": "query", "description": "Represents an end date in the yyyy-MM-ddThh:mm:ssZ format." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get all scheduled assignments on project" }, { "info": { "name": "Publish assignments", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/scheduling/assignments/publish", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Publish assignments" }, { "info": { "name": "Create a recurring assignment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/scheduling/assignments/recurring", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Create a recurring assignment" }, { "info": { "name": "Update a recurring assignment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/scheduling/assignments/recurring/:assignmentId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "assignmentId", "value": "5b641568b07987035750505e", "type": "path", "description": "Represents an assignment identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a recurring assignment" }, { "info": { "name": "Delete a recurring assignment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/scheduling/assignments/recurring/:assignmentId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "assignmentId", "value": "5b641568b07987035750505e", "type": "path", "description": "Represents an assignment identifier across the system." }, { "name": "seriesUpdateOption", "value": "ALL", "type": "query", "description": "Represents a series option." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete a recurring assignment" }, { "info": { "name": "Change the recurring period", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/scheduling/assignments/series/:assignmentId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "assignmentId", "value": "5b641568b07987035750505e", "type": "path", "description": "Represents an assignment identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Change the recurring period" }, { "info": { "name": "Get total of users' capacity on workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/scheduling/assignments/user-filter/totals", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get total of users' capacity on workspace" }, { "info": { "name": "Get total capacity of a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/scheduling/assignments/users/:userId/totals", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." }, { "name": "start", "value": "2020-01-01T00:00:00Z", "type": "query", "description": "Represents a start date in the yyyy-MM-ddThh:mm:ssZ format." }, { "name": "end", "value": "2021-01-01T00:00:00Z", "type": "query", "description": "Represents an end date in the yyyy-MM-ddThh:mm:ssZ format." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get total capacity of a user" }, { "info": { "name": "Copy a scheduled assignment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/scheduling/assignments/:assignmentId/copy", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "assignmentId", "value": "5b641568b07987035750505e", "type": "path", "description": "Represents an assignment identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Copy a scheduled assignment" } ] }, { "info": { "name": "Scheduling (Deprecated)", "type": "folder" }, "items": [ { "info": { "name": "Get all scheduled assignments per project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/scheduling/assignments/projects/totals", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "search", "value": "Project name", "type": "query", "description": "Represents a term for searching projects and clients by name." }, { "name": "start", "value": "2020-01-01T00:00:00Z", "type": "query", "description": "Represents a start date in the yyyy-MM-ddThh:mm:ssZ format." }, { "name": "end", "value": "2021-01-01T00:00:00Z", "type": "query", "description": "Represents an end date in the yyyy-MM-ddThh:mm:ssZ format." }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get all scheduled assignments per project" } ] }, { "info": { "name": "Tag", "type": "folder" }, "items": [ { "info": { "name": "Find tags on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/tags", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "name", "value": "feature_X", "type": "query", "description": "If provided, you'll get a filtered list of tags that matches the provided string in their name." }, { "name": "strict-name-search", "value": "", "type": "query", "description": "Flag to toggle on/off strict search mode. When set to true, search by name will only return tags whose name exactly matches the string value given for the 'name' parameter. When set to false, results will also include tags whose name contain the string value, but could be longer than the string value itself. For example, if there is a tag with the name 'applications', and the search value is 'app', setting strict-name-search to true will not return that tag in the results, whereas setting it to false will." }, { "name": "excluded-ids", "value": "90p687e29ae1f428e7ebe657,3r8687e29ae1f428e7eg567y", "type": "query", "description": "Represents a list of excluded ids" }, { "name": "sort-column", "value": "NAME", "type": "query", "description": "Represents a column to be used as sorting criteria." }, { "name": "sort-order", "value": "ASCENDING", "type": "query", "description": "Represents a sorting mode." }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." }, { "name": "archived", "value": "false", "type": "query", "description": "Filters the result whether tags are archived or not." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Find tags on a workspace" }, { "info": { "name": "Add a new tag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/tags", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Add a new tag" }, { "info": { "name": "Get a tag by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/tags/:id", "params": [ { "name": "id", "value": "21s687e29ae1f428e7ebe404", "type": "path", "description": "Represents a tag identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get a tag by ID" }, { "info": { "name": "Update a tag", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/tags/:id", "params": [ { "name": "id", "value": "21s687e29ae1f428e7ebe404", "type": "path", "description": "Represents a tag identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a tag" }, { "info": { "name": "Delete a tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/tags/:id", "params": [ { "name": "id", "value": "21s687e29ae1f428e7ebe404", "type": "path", "description": "Represents a tag identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete a tag" } ] }, { "info": { "name": "Template (Deprecated)", "type": "folder" }, "items": [ { "info": { "name": "Get all templates on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/templates", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "name", "value": "", "type": "query", "description": "If provided, you'll get a filtered list of templates that contain the provided string in their name." }, { "name": "cleansed", "value": "", "type": "query", "description": "If set to true will filter out inactive template projects and tasks." }, { "name": "hydrated", "value": "", "type": "query", "description": "If set to true will return hydrated template projects and tasks." }, { "name": "page", "value": "", "type": "query" }, { "name": "page-size", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get all templates on a workspace" }, { "info": { "name": "Create templates on a workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/templates", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Create templates on a workspace" }, { "info": { "name": "Get template by ID on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/templates/:templateId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "templateId", "value": "5b6d45c4b0798751107762b8", "type": "path", "description": "Represents a template identifier across the system." }, { "name": "cleansed", "value": "", "type": "query", "description": "If set to true will filter out inactive template projects and tasks." }, { "name": "hydrated", "value": "", "type": "query", "description": "If set to true will return hydrated template projects and tasks." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get template by ID on a workspace" }, { "info": { "name": "Update a template", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/templates/:templateId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "templateId", "value": "5b6d45c4b0798751107762b8", "type": "path", "description": "Represents a template identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a template" }, { "info": { "name": "Delete a template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/templates/:templateId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "templateId", "value": "5b6d45c4b0798751107762b8", "type": "path", "description": "Represents a template identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete a template" } ] }, { "info": { "name": "Time entry", "type": "folder" }, "items": [ { "info": { "name": "Add a new time entry", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-entries", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Add a new time entry" }, { "info": { "name": "Mark time entries as invoiced", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-entries/invoiced", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Mark time entries as invoiced" }, { "info": { "name": "Get all in progress time entries on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-entries/status/in-progress", "params": [ { "name": "workspaceId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "page-size", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get all in progress time entries on a workspace" }, { "info": { "name": "Get a specific time entry on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-entries/:id", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "id", "value": "64c777ddd3fcab07cfbb210c", "type": "path", "description": "Represents a time entry identifier across the system." }, { "name": "hydrated", "value": "", "type": "query", "description": "Flag to set whether to include additional information of a time entry or not." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get a specific time entry on a workspace" }, { "info": { "name": "Update time entry on a workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-entries/:id", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "id", "value": "64c777ddd3fcab07cfbb210c", "type": "path", "description": "Represents a time entry identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update time entry on a workspace" }, { "info": { "name": "Delete a time entry from a workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-entries/:id", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "id", "value": "64c777ddd3fcab07cfbb210c", "type": "path", "description": "Represents a time entry identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete a time entry from a workspace" }, { "info": { "name": "Get time entries for a user on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/user/:userId/time-entries", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." }, { "name": "description", "value": "Description keywords", "type": "query", "description": "Represents a term for searching time entries by description." }, { "name": "start", "value": "2020-01-01T00:00:00Z", "type": "query", "description": "Represents a start date in the yyyy-MM-ddThh:mm:ssZ format." }, { "name": "end", "value": "2021-01-01T00:00:00Z", "type": "query", "description": "Represents an end date in the yyyy-MM-ddThh:mm:ssZ format." }, { "name": "project", "value": "5b641568b07987035750505e", "type": "query", "description": "If provided, you'll get a filtered list of time entries that matches the provided string in their project id." }, { "name": "task", "value": "64c777ddd3fcab07cfbb210c", "type": "query", "description": "If provided, you'll get a filtered list of time entries that matches the provided string in their task id." }, { "name": "tags", "value": "5e4117fe8c625f38930d57b7,7e4117fe8c625f38930d57b8", "type": "query", "description": "If provided, you'll get a filtered list of time entries that matches the provided string(s) in their tag id(s)." }, { "name": "project-required", "value": "", "type": "query", "description": "Flag to set whether to only get time entries which have a project." }, { "name": "task-required", "value": "", "type": "query", "description": "Flag to set whether to only get time entries which have tasks." }, { "name": "hydrated", "value": "", "type": "query", "description": "Flag to set whether to include additional information on time entries or not." }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." }, { "name": "in-progress", "value": "", "type": "query", "description": "Flag to set whether to filter only in progress time entries." }, { "name": "get-week-before", "value": "2020-01-01T00:00:00Z", "type": "query", "description": "Valid yyyy-MM-ddThh:mm:ssZ format date. If provided, filters results within the week before the datetime provided and only those entries with assigned project or task." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get time entries for a user on a workspace" }, { "info": { "name": "Add a new time entry for another user on workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/user/:userId/time-entries", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." }, { "name": "from-entry", "value": "64c777ddd3fcab07cfbb210c", "type": "query", "description": "Represents a time entry identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Add a new time entry for another user on workspace" }, { "info": { "name": "Bulk edit time entries", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/user/:userId/time-entries", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." }, { "name": "hydrated", "value": "", "type": "query", "description": "If set to true, results will contain additional information about the time entry." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Bulk edit time entries" }, { "info": { "name": "Stop a currently running timer on a workspace for a user", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/user/:userId/time-entries", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Stop a currently running timer on a workspace for a user" }, { "info": { "name": "Delete all time entries for a user on a workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/user/:userId/time-entries", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." }, { "name": "time-entry-ids", "value": "5a0ab5acb07987125438b60f", "type": "query", "description": "Represents a list of time entry ids to delete." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete all time entries for a user on a workspace" }, { "info": { "name": "Duplicate a time entry", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/user/:userId/time-entries/:id/duplicate", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." }, { "name": "id", "value": "8j39fn9307hh5125439g2ast", "type": "path", "description": "Represents a time entry identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Duplicate a time entry" } ] }, { "info": { "name": "Balance", "type": "folder" }, "items": [ { "info": { "name": "Get balances for a policy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-off/balance/policy/:policyId", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "policyId", "value": "63034cd0cb0fb876a57e93ad", "type": "path", "description": "Represents a policy identifier across the system." }, { "name": "page", "value": "1", "type": "query" }, { "name": "page-size", "value": "50", "type": "query" }, { "name": "sort", "value": "USER", "type": "query", "description": "If provided, you'll get result sorted by sort column." }, { "name": "sort-order", "value": "ASCENDING", "type": "query", "description": "Sort results in ascending or descending order." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get balances for a policy" }, { "info": { "name": "Update a balance", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-off/balance/policy/:policyId", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "policyId", "value": "63034cd0cb0fb876a57e93ad", "type": "path", "description": "Represents a policy identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a balance" }, { "info": { "name": "Get balance for a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-off/balance/user/:userId", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "60f924bafdaf031696ec6218", "type": "path", "description": "Represents a user identifier across the system." }, { "name": "page", "value": "", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "", "type": "query", "description": "Page size." }, { "name": "sort", "value": "POLICY", "type": "query", "description": "Sort result based on given criteria" }, { "name": "sort-order", "value": "ASCENDING", "type": "query", "description": "Sort result by providing sort order." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get balance for a user" } ] }, { "info": { "name": "Policy", "type": "folder" }, "items": [ { "info": { "name": "Get policies on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-off/policies", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "page", "value": "", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." }, { "name": "name", "value": "Holidays", "type": "query", "description": "If provided, you'll get a filtered list of policies that contain the provided string in their name." }, { "name": "status", "value": "ACTIVE", "type": "query", "description": "If provided, you'll get a filtered list of policies with the corresponding status." }, { "name": "sort-column", "value": "", "type": "query" }, { "name": "sort-order", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get policies on a workspace" }, { "info": { "name": "Create a time off policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-off/policies", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Create a time off policy" }, { "info": { "name": "Get a time off policy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-off/policies/:id", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "id", "value": "63034cd0cb0fb876a57e93ad", "type": "path", "description": "Represents a policy identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get a time off policy" }, { "info": { "name": "Update a policy", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-off/policies/:id", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "id", "value": "63034cd0cb0fb876a57e93ad", "type": "path", "description": "Represents a policy identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a policy" }, { "info": { "name": "Change a policy status", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-off/policies/:id", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "id", "value": "63034cd0cb0fb876a57e93ad", "type": "path", "description": "Represents a policy identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Change a policy status" }, { "info": { "name": "Delete a policy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-off/policies/:id", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "id", "value": "63034cd0cb0fb876a57e93ad", "type": "path", "description": "Represents a policy identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete a policy" } ] }, { "info": { "name": "Time Off", "type": "folder" }, "items": [ { "info": { "name": "Create a time off request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-off/policies/:policyId/requests", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "policyId", "value": "63034cd0cb0fb876a57e93ad", "type": "path", "description": "Represents a policy identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Create a time off request" }, { "info": { "name": "Change a time off request status", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-off/policies/:policyId/requests/:requestId", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "policyId", "value": "63034cd0cb0fb876a57e93ad", "type": "path", "description": "Represents a policy identifier across the system." }, { "name": "requestId", "value": "6308850156b7d75ea8fd3fbd", "type": "path", "description": "Represents a time off request identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Change a time off request status" }, { "info": { "name": "Delete a time off request", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-off/policies/:policyId/requests/:requestId", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "policyId", "value": "63034cd0cb0fb876a57e93ad", "type": "path", "description": "Represents a policy identifier across the system." }, { "name": "requestId", "value": "6308850156b7d75ea8fd3fbd", "type": "path", "description": "Represents a time off request identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete a time off request" }, { "info": { "name": "Create a time off request for a user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-off/policies/:policyId/users/:userId/requests", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "policyId", "value": "63034cd0cb0fb876a57e93ad", "type": "path", "description": "Represents a policy identifier across the system." }, { "name": "userId", "value": "60f924bafdaf031696ec6218", "type": "path", "description": "Represents a user identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Create a time off request for a user" }, { "info": { "name": "Get all time off requests on a workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/time-off/requests", "params": [ { "name": "workspaceId", "value": "60f91b3ffdaf031696ec61a8", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Get all time off requests on a workspace" } ] }, { "info": { "name": "Group", "type": "folder" }, "items": [ { "info": { "name": "Find all groups on a workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/user-groups", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "project-id", "value": "5a0ab5acb07987125438b60f", "type": "query", "description": "If provided, you'll get a filtered list of groups that matches the string provided in their project id." }, { "name": "name", "value": "development_team", "type": "query", "description": "If provided, you'll get a filtered list of groups that matches the string provided in their name." }, { "name": "sort-column", "value": "NAME", "type": "query", "description": "Column to be used as the sorting criteria." }, { "name": "sort-order", "value": "ASCENDING", "type": "query", "description": "Sorting mode." }, { "name": "page", "value": "1", "type": "query", "description": "Page number." }, { "name": "page-size", "value": "50", "type": "query", "description": "Page size." }, { "name": "includeTeamManagers", "value": "true", "type": "query", "description": "If provided, you'll get a list of team managers assigned to this user group." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Find all groups on a workspace" }, { "info": { "name": "Add a new group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/user-groups", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Add a new group" }, { "info": { "name": "Update a group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/user-groups/:id", "params": [ { "name": "id", "value": "76a687e29ae1f428e7ebe101", "type": "path", "description": "Represents a user group identifier across the system." }, { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Update a group" }, { "info": { "name": "Delete a group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/user-groups/:id", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "id", "value": "76a687e29ae1f428e7ebe101", "type": "path", "description": "Represents a user group identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete a group" }, { "info": { "name": "Add users to a group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/user-groups/:userGroupId/users", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userGroupId", "value": "76a687e29ae1f428e7ebe101", "type": "path", "description": "Represents a user group identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Add users to a group" }, { "info": { "name": "Remove a user from a group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/user-groups/:userGroupId/users/:userId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userGroupId", "value": "76a687e29ae1f428e7ebe101", "type": "path", "description": "Represents a user group identifier across the system." }, { "name": "userId", "value": "5a0ab5acb07987125438b60f", "type": "path", "description": "Represents a user identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Remove a user from a group" } ] }, { "info": { "name": "Workspace (Deprecated)", "type": "folder" }, "items": [ { "info": { "name": "Remove user from a workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/users/:userId", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." }, { "name": "userId", "value": "89b687e29ae1f428e7ebe912", "type": "path", "description": "Represents a user identifier across the system." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "This endpoint is not functional and has been deprecated. A user can be removed/deleted on the CAKE.com Account Members page after deactivating all their existing memberships on all workspaces within an organization." } ] }, { "info": { "name": "Shared Report", "type": "folder" }, "items": [ { "info": { "name": "Generate shared report by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/shared-reports/:id", "params": [ { "name": "dateRangeStart", "value": "", "type": "query" }, { "name": "dateRangeEnd", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" }, { "name": "sortColumn", "value": "", "type": "query" }, { "name": "exportType", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Response depends on report type and export type. Given example is for SUMMARY report and JSON exportType. \n\nShared report data on FREE subscription plan is limited to a maximum interval length of one month (31 days)." }, { "info": { "name": "Get all my shared reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/shared-reports", "params": [ { "name": "workspaceId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "sharedReportsFilter", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Gets all shared reports for current user on given workspace" }, { "info": { "name": "Create a shared report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/shared-reports", "params": [ { "name": "workspaceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Saves shared report with name, options and report filter. \n\nShared report data on FREE subscription plan is limited to a maximum interval length of one month (31 days)." }, { "info": { "name": "Update a shared report", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/shared-reports/:id", "params": [ { "name": "workspaceId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Updates shared report name and/or options" }, { "info": { "name": "Delete a shared report", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/shared-reports/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "workspaceId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Delete a shared report" } ] }, { "info": { "name": "Team Report", "type": "folder" }, "items": [ { "info": { "name": "Generate an attendance report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/reports/attendance", "params": [ { "name": "workspaceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Generate an attendance report" } ] }, { "info": { "name": "Time Entry Report", "type": "folder" }, "items": [ { "info": { "name": "Generate a detailed report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/reports/detailed", "params": [ { "name": "workspaceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Detailed report data on FREE subscription plan is limited to a maximum interval length of one month (31 days)." }, { "info": { "name": "Generate a summary report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/reports/summary", "params": [ { "name": "workspaceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Summary report data on FREE subscription plan is limited to a maximum interval length of one month (31 days)." }, { "info": { "name": "Generate a weekly report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/reports/weekly", "params": [ { "name": "workspaceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Weekly report data on FREE subscription plan is limited to a maximum interval length of one month (31 days)." } ] }, { "info": { "name": "Expense Report", "type": "folder" }, "items": [ { "info": { "name": "Generate an expense report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/reports/expenses/detailed", "params": [ { "name": "workspaceId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Expense report data on FREE subscription plan is limited to a maximum interval length of one month (31 days)." } ] }, { "info": { "name": "Audit Log Report", "type": "folder" }, "items": [ { "info": { "name": "Generate an audit log report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/workspaces/:workspaceId/audit-log", "params": [ { "name": "workspaceId", "value": "64a687e29ae1f428e7ebe303", "type": "path", "description": "Represents a workspace identifier across the system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Generate an audit log report" } ] } ], "bundled": true }