# Fetches audit history based on query parameters

**GET /audit**




## Servers
- Raidiam Directory Sandbox Environment: https://matls-api.sandbox.raidiam.io (Raidiam Directory Sandbox Environment)


## Authentication methods
- O auth


## Parameters
### Headers
- **x-fapi-auth-date** (string)
  The time when the PSU last logged in with the TPP. 
  All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
  Sun, 10 Sep 2017 19:43:31 UTC
- **x-fapi-customer-ip-address** (string)
  The PSU's IP address if the PSU is currently logged in with the TPP.
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.
- **x-customer-user-agent** (string)
  Indicates the user-agent that the PSU is using.


### Query parameters
- **actionType** (string)
  The type of action to search for.
- **organisationId** (string)
  The organisation ID. Required if using API as an organisation administrator
- **resourceType** (string)
  The type of resource to search for.
- **resourceId** (string)
  The ID of the specific resource we want to parse by.
- **parentResourceId** (string)
  The ID of the parent resource we want to parse by.
- **performedBy** (string)
  The user email you want to parse by. This will be performed for createdBy and updatedBy based on the revision type
- **startDate** (string(date-time))
  Optional start of date range to constrain the set of results returned. This will restrict the clients returned to those whose metadata was most recently modified after the specified startDate. The date must be supplied in RFC3339 format. If not supplied, the startDate used will be the epoch.
- **endDate** (string(date-time))
  Optional end of date range to constrain the set of results returned. This will restrict the clients returned to those whose metadata was most recently modified before the specified sendDate. The date must be supplied in RFC3339 format. If not supplied, the endDate used will be the current date and time.
- **page** (integer)
  The page number to return of the result set
- **size** (integer)
  The size of the pages to return
- **sort** (string)
  The field name to sort


## Responses
### 200
Audit history in paginated form
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

#### Body: application/json (object)
- **items** (array[object])

- **empty** (boolean)

- **numberOfElements** (integer)

- **offset** (integer)

- **pageNumber** (integer)

- **pageable** (object)

- **size** (integer)

- **totalPages** (integer)

- **totalSize** (integer)


### 400
Bad Request
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

#### Body: application/json (object)
- **errors** (array[string])
  Validation Error messages

### 401
Unauthorized
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 403
Forbidden
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 404
Not found
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

#### Body: application/json (object)
- **errors** (array[string])
  Validation Error messages

### 429
Too many requests, maximum capacity reached. Requests are now throttled.
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 500
Internal Server Error
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 501
Request is not yet implemented
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

#### Body: application/json (object)
- **errors** (array[string])
  Validation Error messages

### 502
Bad Gateway
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 504
Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.


[Powered by Bump.sh](https://bump.sh)