v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Entity changes (Experimental)

Deleted entities (Experimental)

Retrieves a list of record(s) that were deleted within a specified date range.
The date range is determined by the two parameters start and end.

💡 Note

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.

get/v1/workspaces/{workspaceId}/entities/deleted

Path parameters

workspaceIdstring required

Represents workspace identifier across the system (Experimental)

Example:64a687e29ae1f428e7ebe303

Represents workspace identifier across the system (Experimental)

Query parameters

typestring[] required

Specifies the type of document to be retrieved. Expected values are ${changetracker.update.documentation.description}.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.

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, CUSTOM_FIELDS, USER, USER_GROUPS, INVOICES, APPROVAL_REQUESTS, BALANCE, HOLIDAYS, PTO_POLICY, TIME_OFF_REQUEST.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.

[
  "TIME_ENTRY"
]
startstring

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.

Example:2024-10-29T10:00:00Z

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.

endstring

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.

Example:2024-11-28T10:00:00Z

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.

pagestring
limitstring

Response

OK