Audit

An audit object represents an event undertaken by either a user or api user on your felloh account.

An example of an audit Object

{
  "id": "e4bd9203-cb8a-4a67-87f5-7ae10bc35744",
  "type": "booking:create",
  "entity_id": "7c189f42-415e-4c33-8f00-aa76084692cf",
  "created_at": "2022-08-01T09:04:56.312Z",
  "user":{
    "id": "de25f60e-e796-4e65-a451-442680e66da6"
  },
  "organisation": {
    "id": "Z4321",
    "name": "Felloh"
  }
}

idstring

Unique identifier for the object.

typestring

The event that was undertaken.

typestring

The entity id that event is related to.

created_atdatetime

The datetime at which the event occurred

userobject

A compact organisation object representing the organisation owner of the beneficiary.

organisationobject

A compact user object representing the user that undertook the action.

Fetch all

POST/audit

import axios from 'axios';

const response = await axios(
  {
      method: 'post',
      url: 'https://api.felloh.com/audit',
      data: {
        organisation: 'X9876',
        skip: 10,
        take: 20
      },
      headers: {
        'Content-Type': 'application/json',
        Authorization: `Bearer <YOUR TOKEN HERE>`,
      },
  }
);

JSON RESPONSE

{
  "data": [
    {
      "id": "e4bd9203-cb8a-4a67-87f5-7ae10bc35744",
      "type": "booking:create",
      "entity_id": "7c189f42-415e-4c33-8f00-aa76084692cf",
      "created_at": "2022-08-01T09:04:56.312Z",
      "user":{
        "id": "de25f60e-e796-4e65-a451-442680e66da6"
      },
      "organisation": {
        "id": "Z4321",
        "name": "Felloh"
      }
    }
  ],
  "errors": {},
  "meta": {
    "code": 200,
    "reason": "OK",
    "message": "The request was successful",
    "request_id": "cdd40f5c-9d82-44c2-92e3-b5d2cad364f6",
    "count": 1
  }
}

This endpoint retrieves all audit events. Audit events are sorted by creation date, with the most recent events coming first.

HTTP Method

POST

HTTP Endpoint

PRODhttps://api.felloh.com/audit

SANDBOXhttps://sandbox.felloh.com/audit

Payload

Parameter	Required	Type	Description
organisation	true	string	The organisation ID that you want to fetch audit events for. You can find the organisation that you have access to by using the List all organisations method.
skip	false	Integer	See pagination section for details
take	false	Integer	See pagination section for details

Response

Returns an array of Beneficiary Objects