Skip to main content
POST
/
v3
/
api
/
servicedesk
/
audit-trail
Retrieve audit trail
curl --request POST \
  --url https://api.custody.api-zodia.io/v3/api/servicedesk/audit-trail \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: <api-key>' \
  --header 'submitter-id: <submitter-id>' \
  --data '
{
  "requestIds": [
    "SERV-REQ-GVFD56VGH"
  ],
  "paginationLimit": 10,
  "paginationOffset": 0,
  "sort": {
    "by": "id",
    "order": "ASC"
  }
}
'
[
  {
    "total": 123,
    "items": [
      {
        "requestId": "SERV-REQ-DESRYD767",
        "processingSummaryItems": [
          {
            "role": "MAKER",
            "processingSummary": [
              {
                "name": "API Maker",
                "status": "Created",
                "timestamp": "<string>",
                "companyName": "<string>"
              }
            ],
            "name": "API Maker",
            "status": "Confirmed",
            "timestamp": "<string>",
            "companyName": "ZTEST"
          }
        ],
        "versionNumber": 123,
        "versionAction": 123
      }
    ]
  }
]

Authorizations

X-Signature
string
header
required

Headers

submitter-id
string
required

Email of API user submitting the request

Example:

"api-maker@zodia.io"

Body

application/json

Payload for retrieve audit trail of service requests

requestIds
string[]

Search by request IDs

paginationLimit
number

Number of items in response (default is 10)

Example:

10

paginationOffset
number
Example:

0

sort
object

Response

OK

total
integer<int32>
items
object[]