Get a permit requirement
Safety module
GET/permit-requirements/{id}permitRequirements.get
A permit requirement generated by the jurisdiction permit engine. An unpopulated jurisdiction returns no answer. Returns one permit requirement with its `ETag`. A permit requirement the caller may not see returns 404.
- Requires the capability safety.permit.read.
- OAuth scopes: safety.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the permit requirement. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: PermitRequirement
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the permit requirement. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| rule | string | Yes | Canon permit rule that triggered it.Constraints: length 1 to 300 |
| jurisdiction_id | JurisdictionId | Yes | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$ |
| permit | string | Yes | Permit required.Constraints: length 1 to 300 |
| ahj | string | Yes | Authority having jurisdiction.Constraints: length 1 to 300 |
| permit_state | string | null | Yes | Permit state. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| lead_time | string | Yes | Lead time as canon states it.Constraints: length 1 to 300 |
| trigger_type | string | Yes | What triggers the canon rule: threshold, project, element or condition.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| record_id | string (uuid) | null | Yes | Identifier of the Permit record tracking the requirement. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"rule": "Assembly occupancy",
"jurisdiction_id": "US-FL",
"permit": "Certificate of occupancy",
"ahj": "City Building and Fire",
"permit_state": "Proposed",
"lead_time": "4-6 wks",
"trigger_type": "project",
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X GET "$XOS_BASE_URL/permit-requirements/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.permitRequirements.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.permit_requirements.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos permit-requirements get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f