Search audit history

get

https://{tenant}.onechurchsoftware.com/api/history/logs

Retrieve the audit trail of changes made across the system. Pass key and type to read a single record's history; without them, only direct changes are returned. Entries in modules the caller cannot access are masked. Requires permission to view change logs when not scoped to a record.

Required permission: Change Logs

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

key

int32

≥ 1

The id of a record. Combined with type, returns the audit trail of that record.

identifier

string

Return entries whose record identifier (e.g. the person or batch name) contains the given words.

message

string

Return entries whose message contains the given words.

oldValue

string

Return entries whose previous value contains the given words.

newValue

string

Return entries whose new value contains the given words.

user

string

Return entries made by a user whose name contains the given words.

timestamp.start

date-time

Return entries made on or after this date.

timestamp.end

date-time

Return entries made on or before this date.

operation

string

Comma-delimited list of operation ids: 1 = Added, 2 = Removed, 3 = Updated, 4 = Notification.

type

string

Comma-delimited list of record type names (e.g. Person, Group, Note, Transaction Batch).

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK