Skip to content
KasblyKasbly Docs

Get contract detail

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Contract CUID

Example
cmcont00000001ny11aabbcc0

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

Contract CUID

string
orderId
required

Parent order CUID

string
contractNumber
required

Auto-incremented sequential contract number

number
customerName
required

Customer name (English)

string
customerNameAr

Customer name (Arabic)

string
customerPhone

Customer phone number

string
customerEmail

Customer email

string
customerIdNumber

Customer passport/ID number

string
carDetails

Car snapshot JSON (makeEn, modelEn, year, price, …)

object
totalAmount

Contract total amount

number
currency

ISO 4217 currency

string
vin

Vehicle Identification Number

string
mileage

Vehicle mileage (string, e.g. “12,500 km”)

string
color

Vehicle color

string
status
required

Contract lifecycle status — Draft | Sent | Signed | Cancelled

string
pdfUrl

Generated contract PDF URL (null until generated)

string
Examples
Examplesuccess
{
  "success": true,
  "data": {
    "id": "cmcont00000001ny11aabbcc0",
    "orderId": "cmosor2zy000313ny24hgtfy0",
    "contractNumber": 201,
    "customerName": "Ahmed Ali",
    "customerNameAr": "أحمد علي",
    "customerIdNumber": "A12345678",
    "customerPhone": "+971501234567",
    "customerEmail": "ahmed@example.com",
    "customerAddress": "123 Main St, Dubai, UAE",
    "customerCountry": "UAE",
    "carDetails": {
      "makeEn": "BMW",
      "modelEn": "3 Series",
      "year": 2023,
      "price": 25000
    },
    "totalAmount": 25000,
    "currency": "USD",
    "vin": "WBAXH1C50DD123456",
    "mileage": "12,500 km",
    "status": "Draft",
    "pdfUrl": null,
    "createdAt": "2026-05-01T10:00:00.000Z"
  }
}

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