Skip to main content

ACT365

Minimal httpx based client for the ACT365 API.

API documentation: https://act365api.docs.apiary.io/#

Published on PyPI: https://pypi.org/project/act365/

API Coverage

The ACT365 API is much larger than what this library currently binds. A summary of the full API is kept in docs/ACT365-API-Spec.md; the tables below map that API surface to the Python bindings in Act365Client / Act365Auth and the act365 CLI.

Covered

Authentication

API Binding CLI
POST /api/account/login Act365Auth — automatic bearer-token login, re-login on 401, backoff on 429 credentials via options or env vars

Cardholders

API Binding CLI
List cardholders (GET /api/cardholder) Act365Client.getCardholders() — paginated, supports siteid, enabled, searchString etc. filters act365 cardholders list
Get cardholder by ID Act365Client.getCardholderById() — client-side filter over the list endpoint, not the GET /api/cardholder/{id} endpoint act365 cardholders get --id
Get cardholder by email Act365Client.getCardholderByEmail() — client-side filter over the list endpoint act365 cardholders get --email
Create cardholder (POST /api/cardholder) Act365Client.createCardholder() —
Update cardholder (PUT /api/cardholder) Act365Client.updateCardholder() —

Event Bookings (bindings use /api/* endpoints; delete uses /api2/*)

API Binding CLI
List booking sites (GET /api/Bookingsites) Act365Client.getBookingSites() —
List doors on a site (GET /api/Bookingdoors?siteid={siteid}) Act365Client.getBookingSiteDoors() —
Create booking (POST /api/Bookings) Act365Client.createBooking() —
Get booking (GET /api/Bookings?siteid={siteid}&bookingID={bookingid}) Act365Client.getBooking() act365 bookings get --id
List bookings for a site (GET /api/getbookings?siteid={siteid}&date={dd/MM/YYYY}) Act365Client.getBookings() act365 bookings list
Delete booking (DELETE /api2/Bookings?bookingID={bookingid}) Act365Client.deleteBooking() act365 bookings delete --id / --expired

Act365Client also exposes raw post() / put() / delete() passthroughs for endpoints without dedicated bindings.

Not Covered

No Python bindings exist yet for the following areas of the API:

  • Summary — quick summary of customers/sites (GET /api/summary)
  • Customers — list customers (GET /api/customers)
  • Sites — list/get sites (GET /api/sites, GET /api/sites/{siteid})
  • Site Lockdown — activate / clear / command (POST /api/lockdown/*)
  • ACUs — list, get, register, delete controllers (/api/acus)
  • Doors — list, get, doors-for-cardholder, and door commands (Pass/Normalise/Lock/Unlock, single and bulk) (/api/doors)
  • Door Groups — full CRUD (/api/doorgroups)
  • Cameras — list cameras with live feed URLs (GET /api/cameras)
  • Reports / Events — muster report, manual check-in/check-out, and all log event report variants (site, door, door group, cardholder, cardholder group, category, alarms) (/api/events)
  • Cardholders (remaining) — get by external ID, delete, bulk create/delete, enable/disable (single and bulk), random PIN, switch site, and photo get/set/thumbnail
  • Cardholder Groups — full CRUD (/api/cardholdersgroups)
  • Timezones — full CRUD (/api/timezones)
  • WebHooks — register, unregister, list (/api/webhooks)
  • Video Diagnostics — segmenter and stream diagnostics (/api/video/*)
  • Event Bookings (remaining) — update booking, bulk create, delete by filter, bulk delete by IDs
  • Booking Output Scheduling — door output schedules (POST /api2/Schedule)
  • Localisation — localised strings (GET /api/localisation)
  • Permissions — current user access rights (GET /api/permissions)

Metadata

Release files for act365 1.8.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for act365 1.8.0
File Size Uploaded Provenance
act365-1.8.0.tar.gz 11.8 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for act365 1.8.0
File Interpreter ABI Platform
act365-1.8.0-py3-none-any.whl Python 3 none any Details

Total release size: 24.2 kB

Release files / act365-1.8.0.tar.gz

Download URL act365-1.8.0.tar.gz
Size 11.8 kB
Tags Source
SHA-256 checksum
How to use checksums
e2cd04d7e11e08a8fb66babed091eb27026f30fb5dc9948cdd53b6f5ae952092
BLAKE2b-256 checksum
How to use checksums
242db14459dcff78f4567abb64c4cb3639c32c586f72aa01e9ecbab02573e70b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 11, 2026.

Transparency log

Release files / act365-1.8.0-py3-none-any.whl

Download URL act365-1.8.0-py3-none-any.whl
Size 12.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5b773795237c7eac3db9e08ae496cb4228aad0653f3537837db08292142f998d
BLAKE2b-256 checksum
How to use checksums
6f44ec8f79557ced3e9b7d6df029ce8288c0c61251e11194de4697fce0fea0cf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 11, 2026.

Transparency log

Security for act365 1.8.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for act365-1.8.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 11, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page