Supported operations
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/permits | List all permits |
| GET | /api/v1/permits/:id | Get a permit by ID |
| POST | /api/v1/permits | Create a new permit |
| PATCH | /api/v1/permits/:id | Update a permit |
| DELETE | /api/v1/permits/:id | Delete a permit |
Example request
Replace YOUR_API_KEY with a private key stored in your environment. Replace path parameters with records from your organization.
curl --request GET "/api/v1/permits" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Accept: application/json"Field reference
Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.
| Field | Type | Model requirement | Description |
|---|---|---|---|
id | string | Optional | Unique identifier (auto-generated) |
siteId | uuid | Required | site Id Related resource: |
name | string | Required | name |
permitNumber | string | Optional | permit Number |
type | string | Required | type |
status | enum | Optional | status Values: |
authority | string | Optional | authority |
applicationDate | datetime | Required | application Date |
approvalDate | datetime | Optional | approval Date |
expirationDate | datetime | Optional | expiration Date |
notes | string | Optional | notes |
representativeContactId | uuid | Optional | representative Contact Id |
createdAt | datetime | Optional | Creation timestamp (auto) |
updatedAt | datetime | Optional | Last update timestamp (auto) |