Docs/API/Endpoints Reference

API Endpoints Reference

Complete reference of all available API endpoints. Base URL: https://api.ecpermit.com/v1

Projects

GET/projectsList all projects

GET/projects/{id}Get project details

POST/projectsCreate a project

PUT/projects/{id}Update a project

DELETE/projects/{id}Delete a project

Forms

GET/projects/{projectId}/formsList forms in project

GET/projects/{projectId}/forms/{id}Get form details

POST/projects/{projectId}/formsCreate a form

PUT/projects/{projectId}/forms/{id}Update form data

POST/projects/{projectId}/forms/{id}/actions/{action}Perform workflow action

DELETE/projects/{projectId}/forms/{id}Delete a form

Form Types

GET/projects/{projectId}/form-typesList form types

GET/projects/{projectId}/form-types/{id}Get form type schema

POST/projects/{projectId}/form-typesCreate form type

PUT/projects/{projectId}/form-types/{id}Update form type

DELETE/projects/{projectId}/form-types/{id}Delete form type

Users

GET/projects/{projectId}/usersList project users

POST/projects/{projectId}/users/inviteInvite a user

PUT/projects/{projectId}/users/{id}Update user role

DELETE/projects/{projectId}/users/{id}Remove user from project

Example: Create a Form

POST /v1/projects/proj_123/forms
Content-Type: application/json
Authorization: Bearer sk_live_...

{
  "form_type_id": "ft_456",
  "answers": {
    "q_work_location": "Building A, Floor 3",
    "q_start_date": "2024-01-15T09:00:00Z",
    "q_end_date": "2024-01-15T17:00:00Z",
    "q_hot_work_type": "welding"
  }
}

Pagination

List endpoints support pagination via query parameters:

page — Page number (default: 1)
per_page — Items per page (default: 20, max: 100)
sort — Sort field (e.g., created_at)
order — Sort order (asc or desc)

Filtering

Filter results using query parameters:

GET /v1/projects/proj_123/forms?status=approved&created_after=2024-01-01

OpenAPI Spec

A complete OpenAPI specification is available at /api/docs/openapi.json for generating client SDKs.

Authentication Webhooks