Deleted Entities

Prev Next
Get
/public/v1/core/entity-deleted

Retrieves deleted entity references within a specified date range. At least one of deletedOnStart or deletedOnEnd is required. When only one boundary is provided, the query is scoped to that single day.

Security

The requesting user must have the following permission to retrieve deleted entity references:

  • Administration → Audit Log → View Audit & SMS Log
Security
HTTP
Type Bearer
Header parameters
x-r365-context-tenant-id
stringRequired

Identifies the R365 tenant the request applies to. Required on every request.

Query parameters
deletedOnStart
string (date-time)

Start of the deletion date range (inclusive). Required if deletedOnEnd is not provided. If provided alone, the query is scoped to that single day

deletedOnEnd
string (date-time)

End of the deletion date range (inclusive). Required if deletedOnStart is not provided. If provided alone, the query is scoped to that single day

entityName
string

Filter results to deleted records of the given entity type. Returns all entity types if not specified.

pageSize
integer (int32)

Maximum number of top-level objects to return in one page.

Minimum1.0
Maximum250.0
Default250
continuationToken
string

Cursor from the previous page. Supply the EntityDeletedId of the last record returned to retrieve the next page

Responses
200

Paged array of deleted entity references matching the supplied criteria.

Expand All
object

Paginated response containing deleted entity records.

entities
Array of object | null

Deleted entity records for the current page.

object
entityDeletedId
integer (int32)

Unique sequential identifier of the deleted entity record.

entityId
string (uuid) | null

Identifier of the deleted entity instance.

entityName
string | null

Type name of the deleted entity (e.g. Employee, Transaction, DSS).

deletedOn
string (date-time) | null

Date and time the entity was deleted.

rowVersion
string | null

Concurrency token representing the version of the record at time of deletion.

nextLink
string | null

The URL to retrieve the next page of results, or null if this is the last page.

400

Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.

401

Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.

403

Forbidden — the caller lacks the permission required for this operation.

404

Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.

409

Conflict — the request conflicts with the current state of the resource and cannot be applied.

422

Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.

429

Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.

500

Internal Server Error — an unexpected error occurred while processing the request.