Browse docs

Scan2Evolve REST API

Build powerful integrations to automate employee provisioning, asset management, and inspection workflows. Our REST API provides a simple, secure way to sync data between Scan2Evolve and your existing systems.

v1.0
Secure

OAuth 2.0 client credentials flow with API key authentication. All requests require TLS 1.2+.

Fast

Batch processing with up to 500 records per request. Each record processed independently for reliability.

Reliable

Idempotent operations, detailed error responses, and comprehensive status reporting for every request.

API Endpoints

Employee Sync

Submit batches of employees to create, update, or deactivate workforce records.

Asset Sync

Submit batches of assets with meters and readings to manage equipment records.

Users

Read users, their roles, and site assignments for reporting and integrations.

Sites

Create, list, and update sites using your API credentials.

Groups

Create, list, and update groups; manage team and assignment scope.

Assets

Read assets, their sites and types, documents, and meters.

Response types

List and get response types (e.g. Pass/Fail, Single select) used in templates.

Audit types

List and get audit types used to categorize audit flags and templates.

Incident types

List and get incident type configs for incident reporting and templates.

Quick Links

Authentication

Learn how to authenticate API requests

Error Handling

Understand error responses and rate limiting

IDs

Learn about external IDs and identifiers

Date/Time Format

ISO 8601 format and timezone information

Upcoming Endpoints

We're continuously expanding our API to support more use cases. Here's what's coming soon:

Coming Soon
Webhooks

Receive real-time notifications when events occur in Scan2Evolve. Subscribe to inspection completions, asset updates, employee changes, and more.

Coming Soon
Inspection API

Create, retrieve, and manage inspections programmatically. Submit inspection results from external systems and retrieve inspection data for reporting.

Coming Soon
Sites API

Manage sites and locations programmatically. Create, update, and retrieve site information.

Coming Soon
Templates API

Manage inspection templates and forms. Create custom templates and retrieve template definitions.

Changelog

Track changes, new features, and improvements to the Scan2Evolve API.

v1.0.0
November 18, 2024
Added
  • Asset Sync endpoint - Synchronize assets, meters, and meter readings
  • Enhanced error responses with detailed field-level validation
  • Rate limit headers in all API responses
  • Comprehensive error scenario documentation
Improved
  • Employee Sync endpoint now supports batch processing with partial success handling
  • Better error messages for missing required fields
  • Documentation improvements with more examples and use cases
v1.0.0-beta
October 15, 2024
Initial Release
  • Employee Sync endpoint - Create, update, and deactivate employees
  • API key authentication with Basic Auth and Bearer tokens
  • Batch processing support
  • User account provisioning
  • Role and group assignment

Next steps

By now, you should have a basic understanding of the Scan2Evolve API. You can continue to learn about all the available endpoints and parameters, or take a look at the Introduction guide that you might like to try yourself.

Continue Learning

Explore the complete API reference with detailed examples, error handling, and best practices.

Get Started

Generate your API credentials and start building your integration with the Scan2Evolve API.

Top