Documentation
  1. API
  • Visitor Management API
    • Getting Started
      • Overview
    • API Reference
      • Logs
        • Get filtered Events logs
      • Accesses
        • Create new QR Access
      • Users
        • Create new Property Manager
        • Update existing Property Manager
    • External Visits
      • External NFC Visit
  • Visitor Management Webhooks
    • Getting started with webhooks
    • Security & Signature Verification
  • Work Permit DAMAC integration
    • API
      • Create contractor
        POST
      • Revoke contractor
        PATCH
      • Create NOC / fit-out permit
        POST
      • Get permit (reconciliation)
        GET
      • Update permit — dates / NOC
        PATCH
      • Revoke or reissue a permit pass
        PATCH
    • Webhooks
      • passes.permits.issued
      • passes.permits.updated
      • passes.permits.expiring
      • passes.permits.expired
      • passes.permits.scanned
      • passes.permits.firstScanned
      • passes.permits.lastScanned
      • communityContractors.approved
      • communityContractors.removed
  1. API

Get permit (reconciliation)

GET
/permits/{id}
[E-05] Reconciliation endpoint.
Returns the full current state of a permit — status, validity window, and access-code status — so Salesforce can detect drift after a lost or delayed webhook.

Request

Path Params

Responses

🟢200OK
application/json
Current permit state.
Bodyapplication/json

🟠401Unauthorized
🟠404Record Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/permits/'
Response Response Example
200 - Example 1
{
    "permitId": "66f0a1b2c3d4e5f600000abc",
    "passNumber": "WP-002391",
    "status": 1,
    "statusName": "ACCEPTED",
    "type": "permits",
    "permitType": "buildUp",
    "communityId": "6840270a99ca91002185fcd6",
    "propertyId": "66e0000000000000000000a1",
    "flatId": "66e0000000000000000000b2",
    "communityContractorId": "66f0a1b2c3d4e5f600000001",
    "salesforceId": "a1B5g000000XYZWEAW",
    "validFrom": "2026-07-01T06:00:00.000Z",
    "validTill": "2026-07-31T18:00:00.000Z",
    "accessCode": "7H2KQ9ZTM4XB1RPA8VC0DLEN",
    "permitDocumentationUrl": "string"
}
Previous
Create NOC / fit-out permit
Next
Update permit — dates / NOC
Built with