Skip to content

Audit

GET
/audit/v2/{bucket}/audit

Pull audit log messages across the whole client for a time period Available as standard JSON packet or a list for easier reading Note the call is time limited to 20 seconds, so if you have a lot of audit messages you may need to reduce the limit and break into multiple calls

bucket
required

The bucket (client) name

string
Example
example
limit
integer
default: 250
skip
integer
0
from

A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm

string
default: yesterday
Example
2023-09-05T11:27:06.437000
to

A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm

string
default: now
Example
2023-09-05T11:27:06.437000
resource

The type of resource, usually the second element in the URI e.g person, organisation, member, payment

string
Example
person
format
string
default: json
Allowed values: json list

Successful operation

A standard error message

object
description

A human readable description of the error

string
error

A concise error message

string
type

A machine readable error type

string

Unauthorized is the status code to return when the client provides no credentials or invalid credentials.

Forbidden is the status code to return when a client has valid credentials but not enough privileges to perform an action on a resource.

Not found

An error occurred within sheepCRM, please report to support@sheepcrm.com