Skip to main content

Device App Access Devices

Endpoints Summary

Method Path Swagger GET /device_app_access_devices/ Swagger ↗

The Device App Access Devices API provides endpoints for retrievingmanaging and managingretrieving access point devices within the GATE system. This APIendpoint allows developersyou to querylist and filter access control devices,devices filtersuch byas modificationdoor dates,controllers, card readers, and paginateother throughphysical largeaccess devicepoints inventoriesused for integration withbuilding security managementand systems.entry management.

Base URL: https://gate.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The Device App Access Devices API is designed for managing physical access control infrastructuredevices within organizations.your organization's security infrastructure. This API providescategory focuses on access topoints access- pointthe hardware devices that control physical entry to buildings, rooms, or secure areas. Each device represents a physical access control point with comprehensive location data, organizational context, and operational status.

Key Concepts:Features:

  • Retrieve Accesscomprehensive Devices:lists Physicalof hardware devices (card readers, biometric scanners, keypads) that control entry points
Organization Context: All devices are associated with specific organizations for multi-tenantall access control devices Filter Locationdevices Data:by Comprehensivetheir addressinglast modification date Access detailed device information including location data, status, and GPSconfiguration coordinatesSupport for precisepagination to handle large device inventories Geographic information for device mapping Activity Tracking: Last change timestamps enable synchronization and auditlocation capabilitiesservices

Common Integration Scenarios:

  • SynchronizingBuilding management systems that need to display all access controlpoints
systemsSecurity withdashboards showing device status and locations Mobile applications for facility management platforms BuildingReporting securitysystems dashboardsthat track device changes and monitoring applicationsmaintenance IntegratingIntegration with visitormapping managementservices and employee onboarding systems Creating location-based security reports and analytics Managingusing device inventories across multiple facilitiescoordinates

TheAccess APIdevices usesin standardthe paginationGATE patternssystem represent physical hardware like card readers, biometric scanners, door controllers, and supportsgate filteringmechanisms. byEach modificationdevice dates,contains makingdetailed itlocation idealinformation, foroperational incremental synchronization workflowsstatus, and real-timeorganizational monitoringassignment applications.data.

Endpoints

GET /device_app_access_devices/

Description: Retrieves a paginated list of all access control devices within comprehensiveyour location and organizational data.organization. This endpoint isprovides essential for buildingcomprehensive device inventories,information synchronizingincluding location data, operational status, and device metadata. Use this endpoint to get an overview of your access control systems,infrastructure andor creatingto facility management integrations. The response includes detailed addressing information, GPS coordinates, andsynchronize device metadatadata suitablewith forexternal mapping and reporting applications.systems.

Use Cases:

  • BuildingDisplay comprehensiveall access points in a security management dashboard
Synchronize device inventories for security audits Synchronizing access control datainventory with external facility management systems CreatingGenerate interactivereports on access control infrastructure Build device location maps ofusing accesslatitude/longitude points across multiple locationscoordinates Generating compliance reports showingMonitor device locationsstatus and statusrecent Implementingconfiguration real-time monitoring dashboards for security operationschanges

Full URL Example:

https://gate.zequenze.com/api/v1/device_app_access_devices/?limit=50&offset=0&last_change__gte=2024-01-01T00:00:00Z

Parameters:

Parameter Type In Required Description
last_change__gte string query No Filter devices modified on or after this timestampdate (ISO 8601 format). Useful for incremental synchronizationsync operations
limit integer query No Number of results to return per page (default: system configured,defined, typicallyrecommended: 20-50-100)
offset integer query No StartingThe initial index forfrom pagination.which Useto withreturn limitresults (used for traversing large device inventoriespagination)

cURL Example:

curl -X GET "https://gate.zequenze.com/api/v1/device_app_access_devices/?limit=25&last_change__gte=2024-01-01T00:00:00Z"offset=0" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 147,156,
  "next": "https://gate.zequenze.com/api/v1/device_app_access_devices/?limit=25&offset=25",
  "previous": null,
  "results": [
    {
      "id": 1001,
      "name": "Main Entrance Card Reader",
      "short_name": "main-entrance-cr"reader",
      "is_active": true,
      "description": "Primary access control pointdevice for building main entrance with integrated camera system"entrance",
      "organization_id": "org_12345678"org-12345",
      "thumbnail": "https://gate.zequenze.com/media/devices/thumbnails/reader_001.main-entrance-thumb.jpg",
      "address": "123 Corporate Blvd",
      "reference": "Building A - LevelMain 1"Entry",
      "city": "San Francisco",
      "postal_code": "94105",
      "state": "California",
      "region": "BayNorthern Area"California",
      "country_code": "US",
      "latitude": "37.7749",
      "longitude": "-122.4194",
      "created": "2024-01-15T08:15T10:30:00Z",
      "last_change": "2024-01-20T14:02-10T14:22:15Z"33Z"
    },
    {
      "id": 1002,
      "name": "Executive Floor Biometric Scanner",
      "short_name": "exec-bio-scanner"floor-biometric",
      "is_active": true,
      "description": "High-security biometric access control for executive floor with dual authentication"level",
      "organization_id": "org_12345678"org-12345",
      "thumbnail": "https://gate.zequenze.com/media/devices/thumbnails/bio_scanner_002.biometric-scanner-thumb.jpg",
      "address": "123 Corporate Blvd",
      "reference": "Building A - LevelFloor 15",
      "city": "San Francisco",
      "postal_code": "94105",
      "state": "California",
      "region": "BayNorthern Area"California",
      "country_code": "US",
      "latitude": "37.7749",
      "longitude": "-122.4194",
      "created": "2024-01-10T12:20T09:15:00Z",
      "last_change": "2024-01-18T09:02-08T11:45:30Z"22Z"
    }
  ]
}

Response Codes:

Status Description
200 Success - Returns paginated list of access devices with full metadata
401 Unauthorized - Invalid or missing Bearer token
403 Forbidden - Token valid but lacks permission to access device datadevices
400500 BadInternal RequestServer Error - InvalidContact querysupport parametersif (e.g., malformed date format)persistent

Common Use Cases

Use Case 1: Real-timeBuilding DeviceSecurity Inventory SynchronizationDashboard

IntegrateCreate with facility management systems by polling for device changes using the last_change__gte parameter. This enablesa real-time synchronization of access control infrastructure with building management platforms, ensuring accurate device status and location data across all systems.

Use Case 2: Security Compliance Reporting

Generate comprehensive reportsdashboard showing all access control devices acrossin multipleyour facilities,facilities. includingUse the base endpoint to retrieve all devices and display their physicalstatus, locations, operationaland status,recent activity. Filter by last_change__gte to highlight recently modified devices that may need attention.

Use Case 2: Device Inventory Synchronization

Synchronize your access control device inventory with external facility management or maintenance systems. Use pagination with consistent limit values and organizationaltrack assignments.the Thelast_change detailedtimestamps addressingto andperform GPSincremental dataupdates supportsrather regulatorythan compliancefull requirements and security audits.synchronization.

Use Case 3: Interactive Facility Security Maps

Build interactive dashboardsmaps of your facilities showing access point locationslocations. usingUse the latitude/longitude coordinateslatitude and addresslongitude information.fields Theto plot device positions, with thumbnail images and detaileddescription descriptions provide rich contexttext for securitydevice personneldetails monitoringin facilitymap access points.popups.

Use Case 4: Device Maintenance Schedulingand Compliance Reporting

TrackGenerate devicereports metadata and last change timestamps to implement predictive maintenance workflows. The comprehensive device information supports maintenance scheduling, warranty tracking, and replacement planning foron access control infrastructure.infrastructure for compliance audits or maintenance scheduling. Filter devices by location (city, state, country_code) or use last_change__gte to identify devices that haven't been updated recently and may need inspection.

Use Case 5: Multi-tenantMobile AccessFacility Management App

UtilizeDevelop organization_idmobile filteringapplications (whenfor available)security personnel or facility managers. Use the API to manageshow nearby access control devices acrossbased multipleon tenantsgeographic orcoordinates, businessdisplay units,device ensuring proper isolationstatus, and provide quick access controlto indevice enterpriseinformation environments.and controls.

Best Practices

  • Implement Pagination: Strategy:Always Useuse appropriatelimit and offset parameters when dealing with large device inventories. A limit valuesof (25-100) based on your application's memory constraints and network conditions. Implement cursor-based pagination using the provided next/previous URLs for consistent results.

Incremental Synchronization: Leverage the last_change__gte parameter for efficient data synchronization. Store the last sync timestamp and only retrieve50-100 devices modifiedper sincerequest theprovides lastgood syncperformance towithout minimize API calls and data transfer.

Error Handling: Implement robust retry logic for temporary failures, and cache device data locally to handle API unavailability. Always validate the response structure before processing device data inoverwhelming your application.

RateUse Limiting:Incremental Updates: MonitorLeverage APIthe responselast_change__gte headersparameter to fetch only recently modified devices, reducing bandwidth and processing time for ratesynchronization limitingoperations.

Cache Device Data: Device information andtypically implementdoesn't exponentialchange backofffrequently. strategies.Implement Consider implementing localappropriate caching strategies with cache invalidation based on last_change timestamps.

Handle Geographic Data: When using latitude and longitude coordinates, validate that both values are present before attempting to reduceplot APIdevices callson formaps, frequentlyas accessedsome devicedevices may not have location data.

SecurityMonitor Considerations:Active Status: DeviceAlways locationcheck andthe organizationalis_active datafield iswhen sensitivedisplaying -devices ensureto secureusers. storageInactive ofdevices APImay responsesbe andoffline implementfor appropriate access controls in your application. Never logmaintenance or expose API tokens in client-side code or logs.decommissioned.

DataStore Validation:Organization Context: The organization_id field helps maintain proper data isolation in multi-tenant applications. Always validateverify GPSdevice coordinatesaccess arepermissions withinbased expectedon rangesuser andorganization address data is properly formatted before using in mapping or reporting applications. Handle optional fields gracefully as not all devices may have complete location data.membership.

Back to top