📄️ API Information
Here you can find some core information, mainly how to authenticate, about the Resgrid API.
📄️ API Authentication
Resgrid as of the v4 version of the API uses the JWT (JSON Web Token) standard with OpenID Connect. You need to auth to the Resgrid API via a specific endpoint before you can call operations against the API.
📄️ Workflows API
The Workflows API provides full CRUD operations for workflows, workflow steps, credentials, and access to execution history and health metrics. All endpoints are scoped to the authenticated user's department and require Department Admin permissions.
📄️ Contact Verification API
The Contact Verification API allows clients to programmatically send verification codes and confirm contact methods for the authenticated user. These endpoints are used by the profile UI to manage email, mobile number, and home number verification inline.
📄️ User Defined Fields API
The User Defined Fields API provides full programmatic access to UDF definitions, field configurations, field values, and the mobile rendering schema. All endpoints are scoped to the authenticated user's department.
📄️ Calendar Export API
The Calendar Export API provides endpoints for exporting calendar events as iCalendar (.ics) files and managing calendar feed subscriptions. These endpoints are part of the v4 API and are served by the CalendarExportController.
📄️ Custom Maps API
The Custom Maps API provides programmatic access to department-owned custom maps, floors, zones, and coordinate resolution. All endpoints are scoped to the authenticated user's department.