KAkantata
Time Off Entries

Fetching a list of Time Off Entries

Returns time off entries which are visible to the user. Items are visible to a user if they are on the same account.

This endpoint returns structured Time Off 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_off_entries top-level JSON key. Please see our Response Format section for more information.

get/time_off_entries

Request

  • Base URL
    https://api.mavenlink.com/api/v1
  • Auth
    none declared

Query parameters

created_afterstring date-time

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_beforestring date-time

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

end_datestring date

Include only time off entries prior to the specified date. The date must be in ISO 8601 format.

external_reference_external_messagestring

Filter the objects based on the external message of their associated external references. This is an exact match.

external_reference_external_statusstring

Filter by the status of the external object in the external system.

external_reference_service_modelstring

Filter by the type of the external object this external reference belongs to.

external_reference_service_model_refinteger

Filter by the id of the external object this external reference belongs to.

external_reference_service_model_refsstring

Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs.

external_reference_service_namestring

Filter by the name of the provider for integration.

external_reference_statusstring

Filter by the status of the integration, this can be successful or fail.

has_external_referencesboolean

Filter by whether or not the object has external references.

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • role (Role) - Retrieves the account role of the user associated to the time off entry, if any. The response will include role_id, which references the data in the roles top-level key.
  • user (User) - Reference the user associated to the time off entry.
onlystring

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.

pageinteger
per_pageinteger
start_datestring date

Include only time off entries after the specified date. The date must be in ISO 8601 format.

updated_afterstring date-time

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_beforestring date-time

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

user_idinteger

Include only time off entries for the specified User ID.

user_idsinteger[]

Include only time off entries for the specified users. Provide a comma-separated list of user IDs.

without_external_reference_service_namestring

Exclude by the existence of an external reference with the specified service name.

workspace_idinteger

Filter for participants of a specific project.

Response

A list of Time Off Entries have been retrieved.

countinteger
time_off_entriesobject
external_referencesobject
usersobject
rolesobject

Changes

No recorded changes to this operation across all 1 revision of this API.