Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
version: 1.0.0
title: Kantata OX API Documentation Time Entries API
description: Kantata OX's API provides access to the majority of Kantata OX's data model.
termsOfService: https://www.kantata.com/terms-of-use
contact:
name: Kantata OX Support
url: https://knowledge.kantata.com/hc/en-us
license:
name: COPYRIGHT © 2026 Kantata, Inc.
url: https://www.kantata.com/terms-of-use
x-logo:
url: https://theme.zdassets.com/theme_assets/56104/04e93064d309f75d054b8cee885d1ea51e9be8f7.png
backgroundColor: '#FFFFFF'
altText: Kantata OX API Documentation
href: https://developer.kantata.com
servers:
- url: https://api.mavenlink.com/api/v1
tags:
- name: Time Entries
description: 'This object allows you to manage Kantata OX time entries, depending on your permissions.
Creating and updating time entries allows you to include time when invoicing clients.'
paths:
/time_entries:
get:
summary: Fetching a list of Time Entries
description: 'Returns all time entries visible to the requesting user, unless filter parameters
have been applied.
This endpoint returns structured Time Entry objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array
and will be indexed by ID in the `time_entries` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Get Time Entries
tags:
- Time Entries
parameters:
- in: query
name: approved
description: Filter for time entries that are on approved timesheets or are in a project that does not require approvals. When included in your request, this filter is always processed as `true`; the actual value you provide is ignored.
schema:
type: boolean
- in: query
name: billable
description: Return only billable (`true`) or only non-billable (`false`) time entries.
schema:
type: boolean
- in: query
name: created_after
description: Filter for records created after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
schema:
type: string
format: date-time
- in: query
name: created_before
description: Filter for records created before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
schema:
type: string
format: date-time
- in: query
name: created_by
description: Filter for time entries created by the specified user.
schema:
type: integer
format: int32
- in: query
name: date_performed_between
description: "Filter for time entries with work performed between 2 dates in a colon-separated YYYY-MM-DD format.\n For example, `2013-06-01:2013-08-01`."
schema:
type: string
- in: query
name: external_reference_external_message
description: Filter the objects based on the external message of their associated external references. This is an exact match.
schema:
type: string
- in: query
name: external_reference_external_status
description: Filter by the status of the external object in the external system.
schema:
type: string
- in: query
name: external_reference_service_model
description: Filter by the type of the external object this external reference belongs to.
schema:
type: string
- in: query
name: external_reference_service_model_ref
description: Filter by the id of the external object this external reference belongs to.
schema:
type: integer
format: int32
- in: query
name: external_reference_service_model_refs
description: Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs.
schema:
type: string
- in: query
name: external_reference_service_name
description: Filter by the name of the provider for integration.
schema:
type: string
- in: query
name: external_reference_status
description: Filter by the status of the integration, this can be successful or fail.
schema:
type: string
- in: query
name: from_archived_workspaces
description: If `true`, includes time entries from archived projects.
schema:
type: boolean
default: false
- in: query
name: has_external_references
description: Filter by whether or not the object has external references.
schema:
type: boolean
- in: query
name: in_active_invoice_id
description: Limit results to time entries current in the specified active invoice.
schema:
type: integer
format: int32
- in: query
name: in_active_submission
description: "If true, filters for time entries that are part of active timesheet submissions (`active_submissions`).\n If false, filters for time entries that are not part of an active submission."
schema:
type: boolean
- in: query
name: include
description: 'Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.
- `active_submission` (TimesheetSubmission) - Retrieves the active timesheet (i.e. approved or pending) the time entry was submitted on, if any. The response will include `active_submission_id`, which references the data in the `timesheet_submissions` top-level key.
- `external_references` (ExternalReference) - Includes references to external integrations for this object.
- `invoice` (Invoice) - Retrieves the invoice the time entry was added to, if any. The response will include `invoice_id`, which references the data in the `invoices` top-level key.
- `recent_submission` (TimesheetSubmission) - Retrieves the most recent timesheet the time entry was submitted on, if any, including any rejected or cancelled timesheets. The response will include `recent_submission_id`, which references the data in the `timesheet_submissions` top-level key.
- `role` (Role) - Retrieves the project role of the user who performed the work for the time entry, if any. The response will include `role_id`, which references the data in the `roles` top-level key.
- `story` (Story) - Retrieves the task the time entry is tracked to, if any. The response will include `story_id`, which references the data in the `stories` top-level key.
- `user` (User) - Retrieves the user the time entry belongs to. The response will include `user_id`, which references the data in the `users` top-level key.
- `workspace` (Workspace) - Retrieves the project the time entry is tracked to. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.'
schema:
type: string
- in: query
name: invoiced
description: Filter for time entries that have been invoiced. When included in your request, this filter is always processed as `true`; the actual value you provide is ignored. To get uninvoiced time entries instead, use the `uninvoiced` filter.
schema:
type: boolean
- in: query
name: on_my_account
description: If `true`, only time entries that are in internal projects (i.e. projects that are on the same account as the authenticated user) are returned. If `false`, time entries that are in both internal and external projects are returned.
schema:
type: boolean
default: true
- in: query
name: only
description: 'Allows you to request one or more resources directly by ID. Multiple IDs can be supplied
in a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`.'
schema:
type: string
- in: query
name: optional_fields
description: Allows you to request one or more optional fields as an array.
schema:
type: array
items:
type: string
enum:
- location_id
- user_can_edit
- in: query
name: order
description: 'Supply `order` with the name of a valid sort field for the endpoint and a direction.
Valid values: `created_at:asc`, `created_at:desc`, `date_performed:asc`, `date_performed:desc`, `updated_at:asc`, and `updated_at:desc`.'
schema:
type: string
default: date_performed:desc
- in: query
name: page
schema:
type: integer
format: int32
default: 1
- in: query
name: per_page
schema:
type: integer
format: int32
default: 20
maximum: 200
- in: query
name: uninvoiced
description: Filter for time entries that have not been invoiced. When included in your request, this filter is always processed as `true`; the actual value you provide is ignored. To get invoiced time entries instead, use the `invoiced` filter.
schema:
type: boolean
- in: query
name: updated_after
description: Filter for records updated after a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
schema:
type: string
format: date-time
- in: query
name: updated_before
description: Filter for records updated before a specified datetime. The datetime must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
schema:
type: string
format: date-time
- in: query
name: with_recent_timesheet_ids
description: 'Filter for time entries from the specified [`TimesheetSubmission`](/tag/Timesheet-Submissions) IDs, including from canceled and rejected reports.
Give multiple report IDs in a comma separated list.
**Note**: Time entries are only associated with the most recent TimesheetSubmission (see `recent_submission`).
If you re-submit time from a canceled or rejected timesheet, a new `TimesheetSubmission` object is created,
and the time entries will only be returned in association with the new `TimesheetSubmission` from then on,
instead of with the canceled or rejected `TimesheetSubmission`.
Also note that there can only be 1 project per TimesheetSubmission. When a timesheet is submitted through the application frontend with
time entries for multiple projects, separate TimesheetSubmission objects are created for each project in the backend.'
schema:
type: string
- in: query
name: with_timesheet_id
description: "Filter for time entries from a specified [`TimesheetSubmission`](/tag/Timesheet-Submissions) ID.\n If the timesheet was canceled or rejected, no result is returned."
schema:
type: integer
format: int32
- in: query
name: with_user_ids
description: "Filter for time entries associated with the specified user IDs.\n Give multiple user IDs in a comma separated list. For example, '1,2,3'."
schema:
type: string
- in: query
name: without_external_reference_service_name
description: Exclude by the existence of an external reference with the specified service name.
schema:
type: string
- in: query
name: workspace_id
description: Filter for time entries from the specified project.
schema:
type: integer
format: int32
- in: query
name: workspace_ids
description: "Filter for time entries associated with the specified project IDs.\n Give multiple project IDs in a comma separated list. For example, '1,2,3'."
schema:
type: string
responses:
'200':
description: A list of Time Entries have been retrieved.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
format: int32
meta:
type: object
properties:
count:
type: integer
format: int32
page_count:
type: integer
format: int32
page_number:
type: integer
format: int32
page_size:
type: integer
format: int32
results:
type: array
items:
type: object
properties:
key:
type: string
id:
type: string
time_entries:
type: object
additionalProperties:
$ref: '#/components/schemas/TimeEntry'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
stories:
type: object
additionalProperties:
$ref: '#/components/schemas/Story'
workspaces:
type: object
additionalProperties:
$ref: '#/components/schemas/Workspace'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
timesheet_submissions:
type: object
additionalProperties:
$ref: '#/components/schemas/TimesheetSubmission'
invoices:
type: object
additionalProperties:
$ref: '#/components/schemas/Invoice'
roles:
type: object
additionalProperties:
$ref: '#/components/schemas/Role'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: Forbidden request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'404':
description: Page Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'503':
description: Service is unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
post:
summary: Creating a new Time Entry
description: 'Creates time entries for a user.
**Bulk Create**
This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:
```
{
"time_entries": [
{
"workspace_id": 123,
"date_performed": "2025-01-23",
"time_in_minutes": 60
},
{
"workspace_id": 123,
"date_performed": "2025-01-24",
"time_in_minutes": 60
}
]
}
```
This endpoint returns structured Time Entry objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array
and will be indexed by ID in the `time_entries` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Create Time Entry
tags:
- Time Entries
parameters:
- in: query
name: include
description: 'Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.
- `active_submission` (TimesheetSubmission) - Retrieves the active timesheet (i.e. approved or pending) the time entry was submitted on, if any. The response will include `active_submission_id`, which references the data in the `timesheet_submissions` top-level key.
- `external_references` (ExternalReference) - Includes references to external integrations for this object.
- `invoice` (Invoice) - Retrieves the invoice the time entry was added to, if any. The response will include `invoice_id`, which references the data in the `invoices` top-level key.
- `recent_submission` (TimesheetSubmission) - Retrieves the most recent timesheet the time entry was submitted on, if any, including any rejected or cancelled timesheets. The response will include `recent_submission_id`, which references the data in the `timesheet_submissions` top-level key.
- `role` (Role) - Retrieves the project role of the user who performed the work for the time entry, if any. The response will include `role_id`, which references the data in the `roles` top-level key.
- `story` (Story) - Retrieves the task the time entry is tracked to, if any. The response will include `story_id`, which references the data in the `stories` top-level key.
- `user` (User) - Retrieves the user the time entry belongs to. The response will include `user_id`, which references the data in the `users` top-level key.
- `workspace` (Workspace) - Retrieves the project the time entry is tracked to. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.'
schema:
type: string
- in: query
name: optional_fields
description: Allows you to request one or more optional fields as an array.
schema:
type: array
items:
type: string
enum:
- location_id
- user_can_edit
responses:
'200':
description: Time Entry has been created.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
format: int32
meta:
type: object
properties:
count:
type: integer
format: int32
page_count:
type: integer
format: int32
page_number:
type: integer
format: int32
page_size:
type: integer
format: int32
results:
type: array
items:
type: object
properties:
key:
type: string
id:
type: string
time_entries:
type: object
additionalProperties:
$ref: '#/components/schemas/TimeEntry'
external_references:
type: object
additionalProperties:
$ref: '#/components/schemas/ExternalReference'
stories:
type: object
additionalProperties:
$ref: '#/components/schemas/Story'
workspaces:
type: object
additionalProperties:
$ref: '#/components/schemas/Workspace'
users:
type: object
additionalProperties:
$ref: '#/components/schemas/User'
timesheet_submissions:
type: object
additionalProperties:
$ref: '#/components/schemas/TimesheetSubmission'
invoices:
type: object
additionalProperties:
$ref: '#/components/schemas/Invoice'
roles:
type: object
additionalProperties:
$ref: '#/components/schemas/Role'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: Forbidden request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'404':
description: Page Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'503':
description: Service is unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
requestBody:
content:
application/json:
schema:
type: object
properties:
time_entry:
type: object
properties:
workspace_id:
type: integer
format: int32
description: The ID of the project the time entry is logging work in.
date_performed:
type: string
format: date
description: 'The date the activity for which the time is being entered was performed, format: YYYY-MM-DD. The date must be in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.'
time_in_minutes:
type: integer
format: int32
description: The amount of time in minutes that the activity was worked on.
billable:
type: boolean
description: 'Whether this Time Entry is billable time. If you don''t provide this parameter, `billable` will be defaulted to the
value of the `billable` flag of its associated `Story` if any, otherwise to true.'
rate_in_cents:
type: integer
format: int32
description: The hourly rate for the time entry in cents.
notes:
type: string
description: Any notes added to the time entry. To add line breaks, use `\n`.
role_id:
type: integer
format: int32
description: The ID of the default Role or user assigned Role for the time entry.
story_id:
type: integer
format: int32
description: The ID of the task (story) this time entry is associated with.
user_id:
type: integer
format: int32
description: 'This is set to the current_user ID by default. This parameter is ignored unless the authorizing
user has financial access in the project and is on the consultants team (or if the authorizing
user is an account administrator and has proxy permissions via an account member with
those permissions).'
external_reference:
type: object
description: 'Typically populated programmatically by a third party system via an integration, this is an optional
object that holds data from an external system. It connects objects in an external system with objects in
Kantata OX (for example, to connect a Jira issue to a Kantata OX Project).'
properties:
service_name:
type: string
description: The provider name of the integration. If you are adding multiple external references to the same object, the `service_name` must be unique.
service_model:
type: string
description: The object type of the external object this external reference belongs to.
service_model_ref:
type: string
description: The object ID of the external object this external reference belongs to.
status:
type: string
description: The status of the integration. Options are `successful`, `pending`, or `failed`.
external_message:
type: string
description: The message on the external object.
external_link:
type: string
description: The link to the external object.
external_status:
type: string
description: The status of the external object in the external system.
locked:
type: boolean
description: Whether the subject is locked.
required:
- service_name
- service_model
- service_model_ref
location:
type: string
description: The location of the time entry. Must match the name of an existing account location.
required:
- workspace_id
- date_performed
- time_in_minutes
required: true
delete:
summary: Delete multiple time entries
description: 'The IDs of the time entries to delete can be provided in the `ids` query parameter or via the request body.
Request body example:
```{
"ids": "1,2,3"
}```
If any specified time entries cannot be deleted, the entire request will fail and an error message
will be returned that specifies which ones could not be deleted and why.
This endpoint returns structured Time Entry objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array
and will be indexed by ID in the `time_entries` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Delete Time Entries
tags:
- Time Entries
parameters:
- in: query
name: ids
required: false
description: 'A comma-separated list of IDs of time entries. You can provide up to 100 IDs. The IDs can be
provided in this query parameter or via the request body.'
schema:
type: string
responses:
'204':
description: Time Entry has been deleted.
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'403':
description: Forbidden request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'404':
description: Page Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
'503':
description: Service is unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
/time_entries/{id}:
get:
summary: Fetching a single Time Entry
description: 'This endpoint returns structured Time Entry objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array
and will be indexed by ID in the `time_entries` top-level JSON key.
Please see our Response Format section for more information.'
operationId: Get Time Entry
tags:
- Time Entries
parameters:
- in: path
name: id
required: true
description: The ID of the Model.
schema:
type: integer
- in: query
name: include
description: 'Any of the below associations can be included in your request by providing the `include` param, e.g. `include=association1,association2`.
- `active_submission` (TimesheetSubmission) - Retrieves the active timesheet (i.e. approved or pending) the time entry was submitted on, if any. The response will include `active_submission_id`, which references the data in the `timesheet_submissions` top-level key.
- `external_references` (ExternalReference) - Includes references to external integrations for this object.
- `invoice` (Invoice) - Retrieves the invoice the time entry was added to, if any. The response will include `invoice_id`, which references the data in the `invoices` top-level key.
- `recent_submission` (TimesheetSubmission) - Retrieves the most recent timesheet the time entry was submitted on, if any, including any rejected or cancelled timesheets. The response will include `recent_submission_id`, which references the data in the `timesheet_submissions` top-level key.
- `role` (Role) - Retrieves the project role of the user who performed the work for the time entry, if any. The response will include `role_id`, which references the data in the `roles` top-level key.
- `story` (Story) - Retrieves the task the time entry is tracked to, if any. The response will include `story_id`, which references the data in the `stories` top-level key.
- `user` (User) - Retrieves the user the time entry belongs to. The response will include `user_id`, which references the data in the `users` top-level key.
- `workspace` (Workspace) - Retrieves the project the time entry is tracked to. The response will include `workspace_id`, which references the data in the `workspaces` top-level key.'
schema:
type: string
- in: query
name: optional_fields
description: Allows you to request one or more optional fields as an array.
schema:
type: array
items:
type: string
enum:
- location_id
# --- truncated at 32 KB (116 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavenlink/refs/heads/main/openapi/mavenlink-time-entries-api-openapi.yml