Organi Time API (1.5.27)

Download OpenAPI specification:

API for time tracking features (worklogs, statuses, metadata lookups and reporting).

application

Get available applications

Retrieves a list of available applications for the current worklog context. Useful for filtering worklogs by application.

query Parameters
search
string
debug
string

Responses

Response Schema: application/json
Array
string

Response samples

Content type
application/json
[
  • "string"
]

component

Get Jira components

Retrieves a list of Jira components filtered by jira_component and/or jira_project. Used for mapping worklogs to specific Jira components.

query Parameters
jira_component
string
jira_project
string
debug
string

Responses

Response Schema: application/json
Array
jira_project
required
string
jira_component
required
string

Response samples

Content type
application/json
[
  • {
    }
]

attributeType

Get attribute types

Retrieves all available attribute types. Attribute types define the metadata fields that can be attached to a worklog (e.g., Billable, Location).

query Parameters
debug
string

Responses

Response Schema: application/json
Array
attributeTypeId
number
attributeType
string or null
description
string or null

Response samples

Content type
application/json
[
  • {
    }
]

author

Get authors

Retrieves a paginated list of authors (contacts) from the LDN system who have worklog entries.

query Parameters
top
required
number
skip
required
number
countTotal
required
string
debug
string

Responses

Response Schema: application/json
Array
firmanr
required
number
parentid
number
nummer
required
number
naam
string
voornaam
string
e-mail
string
taal
string

Response samples

Content type
application/json
[
  • {
    }
]

clocking

Get clocking data

Retrieves GPS clocking data for a specific author within a given period. Used to compare registered work hours with actual clock-in/out times.

query Parameters
author
required
string
required
object (PeriodDto)

Responses

Response Schema: application/json
Array
day
required
string <date-time>
totalMinutesToWork
required
number
employeeID
required
number
required
object (GPSTimeDayItem)
Array of objects (GPSTimeClocking)
required
object (GPSTimeDayPart)
flexTime
number

Response samples

Content type
application/json
[
  • {
    }
]

comment

Get worklog comments

Retrieves all comments attached to a specific worklog entry.

path Parameters
worklogId
required
number
query Parameters
debug
string

Responses

Response Schema: application/json
Array
commentId
string
comment
string or null
createdAt
string <date-time>
createdBy
string or null
modifiedAt
string <date-time>
modifiedBy
string or null
deletedAt
string or null <date-time>
deletedBy
string or null
object (CommentTypeEntity)
object (StatusEntity)

Response samples

Content type
application/json
[
  • {
    }
]

commentType

Get comment types

Retrieves all available comment types. Comment types categorize the purpose of a worklog comment (e.g., general, internal, review).

query Parameters
debug
string

Responses

Response Schema: application/json
Array
commentTypeId
number
commentType
string or null
description
string or null

Response samples

Content type
application/json
[
  • {
    }
]

homework

Get current homework percentage

Returns the current percentage of time spent working from home vs working at the office for the given author.

query Parameters
author
required
string

Responses

Response Schema: application/json
home
required
number
work
required
number

Response samples

Content type
application/json
{
  • "home": 0,
  • "work": 0
}

Get homework percentage per quarter

Retrieves homework data grouped by calendar quarters for a specific author and period.

query Parameters
author
required
string
required
object (PeriodDto)

Responses

Response Schema: application/json
Array
required
object (HomeWork)
required
object (QuarterList)

Response samples

Content type
application/json
[
  • {
    }
]

Get homework percentage per month

Retrieves homework data grouped by calendar months for a specific author and period.

query Parameters
author
required
string
required
object (PeriodDto)

Responses

Response Schema: application/json
Array
required
object (HomeWork)
required
object (MonthList)

Response samples

Content type
application/json
[
  • {
    }
]

Get homework percentage for period

Retrieves homework data for a specific author and period, providing a granular view of work locations.

query Parameters
author
required
string
required
object (PeriodDto)

Responses

Response Schema: application/json
Array
from
required
string <date-time>
to
required
string <date-time>
required
object (HomeWork)

Response samples

Content type
application/json
[
  • {
    }
]

issuekey

Search Jira issue keys

Searches for Jira issue keys that are relevant to the user's worklog context.

query Parameters
search
string
debug
string

Responses

Response Schema: application/json
Array
string

Response samples

Content type
application/json
[
  • "string"
]

Get expanded Jira issue info

Retrieves detailed Jira issue information for a specific search term, including expanded properties.

query Parameters
search
required
string
expand
required
string
debug
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get multiple Jira issues info

Retrieves detailed information for a comma-separated list of Jira issue keys.

query Parameters
search
required
string
expand
required
string
debug
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

performanceType

Get performance types

Retrieves available performance types. Performance types define the category of work performed (e.g., Development, Support, Administration).

query Parameters
debug
string

Responses

Response Schema: application/json
Array
performanceTypeId
number
code
string or null
description
string or null
isAdministration
boolean

Response samples

Content type
application/json
[
  • {
    }
]

statusType

Get status types

Retrieves all available status types for worklogs and confirmation flows.

query Parameters
debug
string

Responses

Response Schema: application/json
Array
statusTypeId
number
statusType
string or null
description
string or null

Response samples

Content type
application/json
[
  • {
    }
]

linkType

Get link types

Retrieves available link types. Link types define relationships between worklogs and external entities like Jira projects or customers.

query Parameters
debug
string

Responses

Response Schema: application/json
Array
linkTypeId
number
linkType
string or null
description
string or null

Response samples

Content type
application/json
[
  • {
    }
]

linkItem

Get link items

Retrieves link items that can be associated with worklogs to connect them to external metadata.

query Parameters
debug
string

Responses

Response Schema: application/json
Array
linkItemId
string
id
string or null
value
string or null
object (LinkTypeEntity)

Response samples

Content type
application/json
[
  • {
    }
]

mail

Send configured mailings

Triggers the sending of a pre-configured email mailing list.

query Parameters
list
required
string
debug
string

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

worklog

Propose next worklog time

Suggests a start and end time for the next worklog entry based on the author's previous worklogs and clocking data.

query Parameters
author
required
string
debug
string

Responses

Response Schema: application/json
from
string <date-time>
to
string <date-time>
duration
number

Response samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z",
  • "duration": 0
}

Get single worklog

Retrieves a specific worklog entry by its ID. Supports selection of fields and expansion of related entities.

path Parameters
id
required
number
query Parameters
select
Array of strings
Items Enum: "description" "author" "startDate" "endDate" "performanceTypeId" "createdAt" "createdBy" "modifiedAt" "modifiedBy"

Specifies what items should be returned.
If no items selected: worklogId,description,author,performanceType,startDate,endDate will be returned

expand
Array of strings
Items Enum: "performanceType" "comment" "attribute" "status" "worklogLink" "worklogType" "s" "worklogStatus" "confirmationStatus" "actions"

Specifies what tables should be expanded.

orderBy
Array of strings

Specifies the on what expand tables should be ordered.
It will expand the table when table is not expanded yet.

Possible table properties:

  • comment.commentId
  • comment.comment
  • comment.createdAt
  • comment.createdBy
  • comment.modifiedAt
  • comment.modifiedBy
Possible sort orders: 'asc' or 'desc'
Example: '[comment.createdAt desc, comment.comment asc]'

debug
string

Responses

Response Schema: application/json
worklogId
number
worklogType
required
number
performanceType
required
number
currentStatusTypeId
number
description
required
string
author
required
string
createdBy
string
modifiedBy
string
object (JiraIssueDto)
Array of objects (AttributeDto)
Array of objects (CommentDto)
Array of objects (StatusDto)
startDate
required
string <date-time>
endDate
required
string <date-time>
object (WorklogActions)

Response samples

Content type
application/json
{
  • "worklogId": 0,
  • "worklogType": 0,
  • "performanceType": 0,
  • "currentStatusTypeId": 0,
  • "description": "string",
  • "author": "string",
  • "createdBy": "string",
  • "modifiedBy": "string",
  • "jiraIssue": {
    },
  • "attributes": [
    ],
  • "comments": [
    ],
  • "statuses": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "actions": {
    }
}

Delete worklog

Permanently removes a worklog entry. Requires proper permissions and often a cacheId to update the local state.

path Parameters
id
required
number
query Parameters
cacheId
required
string
debug
string

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Get filtered worklogs

Retrieves a list of worklog entries based on various filters (author, date, status, etc.). Supports pagination, field selection, and relationship expansion.

query Parameters
filter
string

Format: see type WorklogFilter

select
Array of strings
Items Enum: "description" "author" "startDate" "endDate" "performanceTypeId" "createdAt" "createdBy" "modifiedAt" "modifiedBy"

Specifies what items should be returned.
If no items selected: worklogId,description,author,performanceType,startDate,endDate will be returned

expand
Array of strings
Items Enum: "performanceType" "comment" "attribute" "status" "worklogLink" "worklogType" "s" "worklogStatus" "confirmationStatus" "actions"

Specifies what tables should be expanded.

orderBy
Array of strings

Specifies the on what expand tables should be ordered.
It will expand the table when table is not expanded yet.

Possible table properties:

  • comment.commentId
  • comment.comment
  • comment.createdAt
  • comment.createdBy
  • comment.modifiedAt
  • comment.modifiedBy
Possible sort orders: 'asc' or 'desc'
Example: '[comment.createdAt desc, comment.comment asc]'

top
number
skip
number
countTotal
boolean
cacheId
required
string
generateCache
required
string
debug
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new worklog

Creates a new worklog entry. Validates Jira issue restrictions before saving.

query Parameters
debug
string

Responses

Response Schema: application/json
worklogId
number
worklogType
required
number
performanceType
required
number
currentStatusTypeId
number
description
required
string
author
required
string
createdBy
string
modifiedBy
string
object (JiraIssueDto)
Array of objects (AttributeDto)
Array of objects (CommentDto)
Array of objects (StatusDto)
startDate
required
string <date-time>
endDate
required
string <date-time>
object (WorklogActions)

Response samples

Content type
application/json
{
  • "worklogId": 0,
  • "worklogType": 0,
  • "performanceType": 0,
  • "currentStatusTypeId": 0,
  • "description": "string",
  • "author": "string",
  • "createdBy": "string",
  • "modifiedBy": "string",
  • "jiraIssue": {
    },
  • "attributes": [
    ],
  • "comments": [
    ],
  • "statuses": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "actions": {
    }
}

Update existing worklog

Updates an existing worklog entry. Checks for edit permissions and Jira issue restrictions.

query Parameters
debug
string

Responses

Response Schema: application/json
worklogId
number
worklogType
required
number
performanceType
required
number
currentStatusTypeId
number
description
required
string
author
required
string
createdBy
string
modifiedBy
string
object (JiraIssueDto)
Array of objects (AttributeDto)
Array of objects (CommentDto)
Array of objects (StatusDto)
startDate
required
string <date-time>
endDate
required
string <date-time>
object (WorklogActions)

Response samples

Content type
application/json
{
  • "worklogId": 0,
  • "worklogType": 0,
  • "performanceType": 0,
  • "currentStatusTypeId": 0,
  • "description": "string",
  • "author": "string",
  • "createdBy": "string",
  • "modifiedBy": "string",
  • "jiraIssue": {
    },
  • "attributes": [
    ],
  • "comments": [
    ],
  • "statuses": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "actions": {
    }
}

worklogType

Get worklog types

Retrieves all available worklog types. Worklog types define the general category of the time entry.

Responses

Response Schema: application/json
Array
worklogTypeId
number
worklogType
string or null
description
string or null

Response samples

Content type
application/json
[
  • {
    }
]

organiproject

Search Organi projects

Retrieves a list of projects from the Organi system that the user has access to.

query Parameters
search
required
string
debug
string

Responses

Response Schema: application/json
Array
string

Response samples

Content type
application/json
[
  • "string"
]

status

Get confirmation status history

Retrieves the history of confirmation statuses (e.g., Approved by Customer) for a specific worklog.

path Parameters
worklogId
required
number
query Parameters
debug
string

Responses

Response Schema: application/json
Array
statusId
string
statusDate
string or null <date-time>
recipient
string or null
author
string or null
object (StatusTypeEntity)
Array of objects (CommentEntity)

Response samples

Content type
application/json
[
  • {
    }
]

Get worklog status history

Retrieves the history of internal worklog statuses (e.g., To Approve, Reviewed) for a specific worklog.

path Parameters
worklogId
required
number
query Parameters
debug
string

Responses

Response Schema: application/json
Array
statusId
string
statusDate
string or null <date-time>
recipient
string or null
author
string or null
object (StatusTypeEntity)
Array of objects (CommentEntity)

Response samples

Content type
application/json
[
  • {
    }
]

Update confirmation status

Updates the confirmation status of one or more worklogs. Used for customer approval flows.

Request Body schema: application/json
required
worklogIds
required
Array of numbers
statusId
required
number
Enum: 6 7 8 9 10 12

different possible statuses:
6: to approve
7: approved
8: to review
9: reviewed

comment
string

Responses

Response Schema: application/json
success
required
Array of strings

worklogIds the operation was succesfull for

failed
required
Array of strings

worklogIds the operation failed for

denied
required
Array of strings

worklogIds the operation was denied for

Request samples

Content type
application/json
{
  • "worklogIds": [
    ],
  • "statusId": 6,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "success": [
    ],
  • "failed": [
    ],
  • "denied": [
    ]
}

Update worklog status

Updates the internal worklog status of one or more worklogs. Used for internal approval flows.

Request Body schema: application/json
required
worklogIds
required
Array of numbers
statusId
required
number
Enum: 1 4 2 3 5 11

different possible statuses:
1: to approve
2: to review
3: reviewed
4: approved
5: invoiced
11: pre-invoiced

comment
string
orderNumber
string
invoiceNumber
string
invoiceDate
string <date-time>

Responses

Response Schema: application/json
success
required
Array of strings

worklogIds the operation was succesfull for

failed
required
Array of strings

worklogIds the operation failed for

denied
required
Array of strings

worklogIds the operation was denied for

Request samples

Content type
application/json
{
  • "worklogIds": [
    ],
  • "statusId": 1,
  • "comment": "string",
  • "orderNumber": "string",
  • "invoiceNumber": "string",
  • "invoiceDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "success": [
    ],
  • "failed": [
    ],
  • "denied": [
    ]
}

Undo worklog status

Reverts the last worklog status change for one or more worklogs.

Request Body schema: application/json
required
worklogIds
required
Array of numbers
statusId
required
number
Enum: 4 11

different possible statuses to undo:

  • 11: pre-invoice

orderNumber
string

Responses

Response Schema: application/json
success
required
Array of strings

worklogIds the operation was succesfull for

failed
required
Array of strings

worklogIds the operation failed for

denied
required
Array of strings

worklogIds the operation was denied for

Request samples

Content type
application/json
{
  • "worklogIds": [
    ],
  • "statusId": 4,
  • "orderNumber": "string"
}

Response samples

Content type
application/json
{
  • "success": [
    ],
  • "failed": [
    ],
  • "denied": [
    ]
}

Undo confirmation status

Reverts the last confirmation status change for one or more worklogs.

Request Body schema: application/json
required
worklogIds
required
Array of numbers
statusId
required
number
Enum: 6 7 8 9 12

different possible statuses to undo:

  • 7: approved

Responses

Response Schema: application/json
success
required
Array of strings

worklogIds the operation was succesfull for

failed
required
Array of strings

worklogIds the operation failed for

denied
required
Array of strings

worklogIds the operation was denied for

Request samples

Content type
application/json
{
  • "worklogIds": [
    ],
  • "statusId": 6
}

Response samples

Content type
application/json
{
  • "success": [
    ],
  • "failed": [
    ],
  • "denied": [
    ]
}