Skip to main content

Device App Access Devices

The Device App Access Devices API provides endpoints for retrieving and managing access point devices within the GATE system. This API allows developers to query access control devices, filter by modification dates, and paginate through large device inventories for integration with security management systems.

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 access control infrastructure within organizations. This API provides access to access point 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:

  • Access Devices: Physical hardware devices (card readers, biometric scanners, keypads) that control entry points
  • Organization Context: All devices are associated with specific organizations for multi-tenant access control
  • Location Data: Comprehensive addressing and GPS coordinates for precise device mapping
  • Activity Tracking: Last change timestamps enable synchronization and audit capabilities

Common Integration Scenarios:

  • Synchronizing access control systems with facility management platforms
  • Building security dashboards and monitoring applications
  • Integrating with visitor management and employee onboarding systems
  • Creating location-based security reports and analytics
  • Managing device inventories across multiple facilities

The API uses standard pagination patterns and supports filtering by modification dates, making it ideal for incremental synchronization workflows and real-time monitoring applications.

Endpoints

GET /device_app_access_devices/

Description: Retrieves a paginated list of access control devices with comprehensive location and organizational data. This endpoint is essential for building device inventories, synchronizing access control systems, and creating facility management integrations. The response includes detailed addressing information, GPS coordinates, and device metadata suitable for mapping and reporting applications.

Use Cases:

  • Building comprehensive device inventories for security audits
  • Synchronizing access control data with facility management systems
  • Creating interactive maps of access points across multiple locations
  • Generating compliance reports showing device locations and status
  • Implementing real-time monitoring dashboards for security operations

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 timestamp (ISO 8601 format). Useful for incremental synchronization
limit integer query No Number of results to return per page (default: system configured, typically 20-100)
offset integer query No Starting index for pagination. Use with limit for traversing large device inventories

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" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 147,
  "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",
      "is_active": true,
      "description": "Primary access control point for building main entrance with integrated camera system",
      "organization_id": "org_12345678",
      "thumbnail": "https://gate.zequenze.com/media/devices/thumbnails/reader_001.jpg",
      "address": "123 Corporate Blvd",
      "reference": "Building A - Level 1",
      "city": "San Francisco",
      "postal_code": "94105",
      "state": "California",
      "region": "Bay Area",
      "country_code": "US",
      "latitude": "37.7749",
      "longitude": "-122.4194",
      "created": "2024-01-15T08:30:00Z",
      "last_change": "2024-01-20T14:22:15Z"
    },
    {
      "id": 1002,
      "name": "Executive Floor Biometric Scanner",
      "short_name": "exec-bio-scanner",
      "is_active": true,
      "description": "High-security biometric access control for executive floor with dual authentication",
      "organization_id": "org_12345678",
      "thumbnail": "https://gate.zequenze.com/media/devices/thumbnails/bio_scanner_002.jpg",
      "address": "123 Corporate Blvd",
      "reference": "Building A - Level 15",
      "city": "San Francisco",
      "postal_code": "94105",
      "state": "California",
      "region": "Bay Area",
      "country_code": "US",
      "latitude": "37.7749",
      "longitude": "-122.4194",
      "created": "2024-01-10T12:15:00Z",
      "last_change": "2024-01-18T09:45:30Z"
    }
  ]
}

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 lacks permission to access device data
400 Bad Request - Invalid query parameters (e.g., malformed date format)

Common Use Cases

Use Case 1: Real-time Device Inventory Synchronization

Integrate with facility management systems by polling for device changes using the last_change__gte parameter. This enables 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 reports showing all access control devices across multiple facilities, including their physical locations, operational status, and organizational assignments. The detailed addressing and GPS data supports regulatory compliance requirements and security audits.

Use Case 3: Interactive Facility Security Maps

Build interactive dashboards showing access point locations using the latitude/longitude coordinates and address information. The thumbnail images and detailed descriptions provide rich context for security personnel monitoring facility access points.

Use Case 4: Device Maintenance Scheduling

Track device metadata and last change timestamps to implement predictive maintenance workflows. The comprehensive device information supports maintenance scheduling, warranty tracking, and replacement planning for access control infrastructure.

Use Case 5: Multi-tenant Access Management

Utilize organization_id filtering (when available) to manage access control devices across multiple tenants or business units, ensuring proper isolation and access control in enterprise environments.

Best Practices

  • Pagination Strategy: Use appropriate limit values (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 retrieve devices modified since the last sync to 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 in your application.

  • Rate Limiting: Monitor API response headers for rate limiting information and implement exponential backoff strategies. Consider implementing local caching to reduce API calls for frequently accessed device data.

  • Security Considerations: Device location and organizational data is sensitive - ensure secure storage of API responses and implement appropriate access controls in your application. Never log or expose API tokens in client-side code or logs.

  • Data Validation: Always validate GPS coordinates are within expected ranges and 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.

Back to top