Skip to content
KasblyKasbly Docs

Get order audit log

GET
/api/v1/orders/{id}/audit
curl --request GET \
  --url https://api.dokanmazad.com/api/v1/orders/cmosor2zy000313ny24hgtfy0/audit \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Order CUID

Example
cmosor2zy000313ny24hgtfy0

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
success
required
boolean
data
required
meta
object
page
integer
limit
integer
total
integer
totalPages
integer
data
required
object
id
required

Log entry CUID

string
orderId
required

Parent order CUID

string
oldStatus
required

Status BEFORE the transition

string
newStatus
required

Status AFTER the transition

string
changedByUserId
required

CUID of the user who made the change

string
notes

Optional reason/note for the change

string
timestamp
required

When the transition occurred

string format: date-time
changedBy

Embedded actor object { id, name, email }

object
Examples
Examplesuccess
{
  "success": true,
  "data": [
    {
      "id": "cmlog000000001ny11aabbcc0",
      "orderId": "cmosor2zy000313ny24hgtfy0",
      "oldStatus": "DepositSubmitted",
      "newStatus": "DepositConfirmed",
      "changedByUserId": "cmoabcde000004ny44aabbcc0",
      "notes": "Deposit verified via bank transfer",
      "timestamp": "2026-05-02T08:00:00.000Z",
      "changedBy": {
        "id": "cmoabcde000004ny44aabbcc0",
        "name": "Accountant",
        "email": "accountant@example.com"
      }
    }
  ]
}

401

Section titled “401”

Unauthorized — missing or invalid API key

Media typeapplication/json
object
success
required
boolean
error
required
string
statusCode
required
integer
Example
{
  "success": false
}

403

Section titled “403”

Forbidden — route not in this key’s allowedRoutes

Media typeapplication/json
object
success
required
boolean
error
required
string
statusCode
required
integer
Example
{
  "success": false
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
success
required
boolean
error
required
string
statusCode
required
integer
Example
{
  "success": false
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before retrying