API DOCUMENTATION

Integrate Guardian-X into your existing systems and workflows

RESTful API

Guardian-X provides a comprehensive REST API that enables deep integration with your organization's existing tools and systems.

From automating user provisioning to triggering alerts from external systems, the API gives you full programmatic control over your Guardian-X deployment.

RESTful Design
JSON Responses
Token Authentication
TLS 1.3 Encryption
Rate Limiting
OpenAPI Spec

API Capabilities

Powerful endpoints for enterprise integration

User Management

Create, update, and manage users programmatically. Sync with your directory services.

Group Operations

Manage organizational groups, team assignments, and notification hierarchies.

Situation Control

Trigger situations, update status, and manage active emergencies via API.

Notifications

Send targeted notifications to individuals, groups, or your entire organization.

Reporting

Access response data, generate reports, and export historical information.

Webhooks

Receive real-time event notifications in your systems as situations unfold.

Authentication

The Guardian-X API uses token-based authentication. API tokens are scoped to specific permissions and can be revoked at any time.

Example Request 
GET /api/v1/situations
Authorization: Bearer your_api_token
Content-Type: application/json

Rate Limiting

API requests are rate-limited to ensure fair usage and system stability. Enterprise customers receive higher rate limits based on their plan.

Standard 100 requests/minute
Enterprise 1,000 requests/minute
Custom Contact us

API Access

Full API documentation is available to Guardian-X customers. Contact our team to discuss your integration requirements and receive API credentials.

OpenAPI Specification SDK Libraries Code Examples Sandbox Environment

Ready to Integrate?

Contact our solutions team to discuss your integration needs and get API access.

Request API Access