Accela V4 API
Addresses
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get Address | All | addresses | No auth required | GET /v4/addresses/{id} | 7.3.2 |
| Get All Address Parcels | All | addresses | Access token | GET /v4/addresses/{id}/parcels | 7.3.2 |
| Get All Addresses | All | addresses | No auth required | GET /v4/addresses | 7.3.2 |
Addresses/Conditions
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Address Conditions | All | addresses | Access token | GET /v4/addresses/{id}/conditions | 9.0.0 |
Agencies
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get Agency | All | agencies | No auth required | GET /v4/agencies/{name} | All |
| Get Agency Logo | All | agencies | No auth required | GET /v4/agencies/{name}/logo | All |
| Get All Agencies | All | agencies | No auth required | GET /v4/agencies | All |
| Get All Agency Environments | All | agencies | No auth required | GET /v4/agencies/{name}/environments | All |
Announcements
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Announcements | All | announcements | No auth required | GET /v4/announcements | 7.3.3 |
| Mark Announcements as Read | Citizen | announcements | Access token | PUT /v4/announcements/{ids}/read | 7.3.3.4 |
AppSettings
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All App Settings | All | app_data | App Credentials | GET /v4/appsettings | 7.3.2 |
Assessments
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Delete Assessments | Agency | assessments | Access token | DELETE /v4/assessments/{ids} | 9.0.0 |
| Get Assessments | Agency | assessments | Access token | GET /v4/assessments/{id} | 9.0.0 |
| Get My Assessments | Agency | assessments | Access token | GET /v4/assessments/mine | 9.0.0 |
| Update Assessment | Agency | assessments | Access token | PUT /v4/assessments/{id} | 9.0.0 |
Assessments/Attributes
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get Metadata of Condition Assessment Type Attributes | Agency | assessments | Access token | GET /v4/assessments/{id}/attributes/meta | 9.0.0 |
Assessments/Documents
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Assessment Documents | Agency | assessments | Access token | POST /v4/assessments/{assessmentId}/documents | 9.0.0 |
| Delete Assessment Documents | Agency | assessments | Access token | DELETE /v4/assessments/{assessmentId}/documents/{documentIds} | 9.0.0 |
| Get All Assessment Documents | Agency | assessments | Access token | GET /v4/assessments/{assessmentId}/documents | 9.0.0 |
Assessments/Observations
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get Condition Assessment Observations | Agency | assessments | Access token | GET /v4/assessments/{id}/observations | 9.0.0 |
| Get Metadata of Condition Assessment Type Attributes | Agency | assessments | Access token | GET /v4/assessments/{id}/observations/meta | 9.0.0 |
| Update Assessment Observations | Agency | assessments | Access token | PUT /v4/assessments/{id}/observations | 9.0.0 |
Assessments/Records
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Assessment Records | Agency | assessments | Access token | GET /v4/assessments/{caId}/records | 9.0.0 |
Assessments/WorkOrders
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Add Work Orders to Assessment | Agency | assessments | Access token | POST /v4/assessments/{id}/workorders | 9.0.0 |
Assets
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Delete Assets | Agency | assets | Access token | DELETE /v4/assets/{ids} | 9.0.0 |
| Get All Assets | Agency | assets | Access token | GET /v4/assets | 9.0.0 |
| Get All Linked Assets | Agency | assets | Access token | GET /v4/assets/{id}/linkedAssets | 9.0.0 |
| Get Assets | Agency | assets | Access token | GET /v4/assets/{ids} | 9.0.0 |
| Update Asset | Agency | assets | Access token | PUT /v4/assets/{id} | 9.0.0 |
Assets/Assessments
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Asset Assessment | Agency | assessments | Access token | POST /v4/assets/{id}/assessments | 9.0.0 |
Assets/Attributes
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get Asset Custom Attributes | Agency | assets | Access token | GET /v4/assets/{id}/attributes | 9.0.0 |
| Get Metadata of Asset Attributes | Agency | assets | Access token | GET /v4/assets/{id}/attributes/meta | 9.0.0 |
| Update Asset Custom Attributes | Agency | assets | Access token | PUT /v4/assets/{id}/attributes | 9.0.0 |
Assets/Documents
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Asset Documents | Agency | assets | Access token | POST /v4/assets/{assetId}/documents | 9.0.0 |
| Delete Asset Documents | Agency | assets | Access token | DELETE /v4/assets/{assetId}/documents/{documentIds} | 9.0.0 |
| Get All Asset Documents | Agency | assets | Access token | GET /v4/assets/{assetId}/documents | 9.0.0 |
Assets/Records
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Asset Records | Agency | assets | Access token | GET /v4/assets/{assetId}/records | 9.0.0 |
Batch
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Batch Request | All | batch_request | No auth required | POST /v4/batch | All |
CitizenAccess
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create My Citizen Contacts | Citizen | users | Access token | POST /v4/citizenaccess/contacts | 7.3.3.4 |
| Delete My Citizen Contacts | Citizen | users | Access token | DELETE /v4/citizenaccess/contacts/{ids} | 7.3.3.4 |
| Get My Citizen Contacts | Citizen | users | Access token | GET /v4/citizenaccess/contacts | 7.3.3.4 |
| Get My Citizen Profile | Citizen | users | Access token | GET /v4/citizenaccess/profile | 7.3.3.4 |
| Register Citizen | All | users | No auth required | POST /v4/citizenaccess/register | 7.3.3.4 |
CitizenAccess/Citizens
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Citizen | All | users | Access token | POST /v4/citizenaccess/citizens | 7.3.3.4 |
| Create Citizen Contacts | All | users | Access token | POST /v4/citizenaccess/citizens/{id}/contacts | 7.3.3.4 |
| Delete Citizen Contacts | All | users | Access token | DELETE /v4/citizenaccess/citizens/{id}/contacts/{contactIds} | 7.3.3.4 |
| Get Citizen Accounts | All | users | Access token | GET /v4/citizenaccess/citizens/{id}/accounts | 7.3.3.4 |
| Get Citizen Users | All | users | Access token | GET /v4/citizenaccess/citizens | 7.3.3.4 |
| Update Citizen Accounts | All | users | Access token | PUT /v4/citizenaccess/citizens/{id}/accounts | 7.3.3.4 |
| Update Citizen Password | All | users | Access token | PUT /v4/citizenaccess/citizens/{id}/password | 7.3.3.4 |
| Update Citizen Profile | All | users | Access token | PUT /v4/citizenaccess/citizens/{id} | 7.3.3.4 |
CitizenAccess/Citizens/Delegates
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Delegates | Citizen | users | Access token | POST /v4/citizenaccess/citizens/delegates | 7.3.3.5 |
| Delete Delegates | Citizen | users | Access token | DELETE /v4/citizenaccess/citizens/delegates/{ids} | 7.3.3.5 |
| Get All Delegates | Citizen | users | Access token | GET /v4/citizenaccess/citizens/delegates | 7.3.3.5 |
| Get Citizen Delegate Privileges | Citizen | users | Access token | GET /v4/citizenaccess/citizens/delegatePrivileges | 7.3.3.5 |
CitizenAccess/Citizens/Invitations
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Invitations | Citizen | users | Access token | GET /v4/citizenaccess/citizens/invitations | 7.3.3.5 |
| Update Invitation | Citizen | users | Access token | PUT /v4/citizenaccess/citizens/invitation/{id} | 7.3.3.5 |
CitizenAccess/Citizens/TrustAccounts
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get Citizen Trust Accounts | All | users | Access token | GET /v4/citizenaccess/citizens/{id}/trustAccounts | 7.3.3.5 |
CivicID
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Linked User Account | All | civicid | Access token | POST /v4/civicid/accounts | All |
| Delete Linked User Account | All | civicid | Access token | DELETE /v4/civicid/accounts/{id} | All |
| Get All Linked User Accounts | All | civicid | Access token | GET /v4/civicid/accounts | All |
| Get CivicID Profile | All | civicid | Access token | GET /v4/civicid/profile | All |
| Get Linked User Account | All | civicid | Access token | GET /v4/civicid/accounts/{id} | All |
Conditions
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Approval Conditions | Agency | conditions | Access token | GET /v4/conditionApprovals/standard | 7.3.2 |
| Get All Standard Conditions | Agency | conditions | Access token | GET /v4/conditions/standard | 7.3.2 |
Contacts
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Contacts | All | contacts | Access token | POST /v4/contacts | 7.3.2 |
| Delete Contacts | Agency | contacts | Access token | DELETE /v4/contacts/{ids} | 7.3.2 |
| Get All Contacts | All | contacts | Access token | GET /v4/contacts | 7.3.2 |
| Get Contacts | All | contacts | Access token | GET /v4/contacts/{ids} | 7.3.2 |
| Update Contact | Agency | contacts | Access token | PUT /v4/contacts/{id} | 7.3.2 |
Contacts/Addresses
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Contact Addresses | Agency | contacts | Access token | POST /v4/contacts/{id}/addresses | 7.3.2 |
| Get All Contact Addresses | All | contacts | Access token | GET /v4/contacts/{id}/addresses | 7.3.2 |
| Update Contact Address | All | contacts | Access token | PUT /v4/contacts/{contactId}/addresses/{id} | 7.3.3.4 |
Contacts/Conditions
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Contact Conditions | Agency | contacts | Access token | POST /v4/contacts/{contactId}/conditions | 7.3.3.4 |
| Delete Contact Condition | All | contacts | Access token | DELETE /v4/contacts/{contactId}/conditions/{id} | 7.3.3.4 |
| Get All Contact Conditions | All | contacts | Access token | GET /v4/contacts/{contactId}/conditions | 7.3.3.4 |
| Update Contact Condition | All | conditions | Access token | PUT /v4/contacts/{contactId}/conditions/{id} | 7.3.3.4 |
Contacts/CustomForms
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Custom Forms for Contact | All | contacts | Access token | GET /v4/contacts/{id}/customForms | 7.3.3.4 |
| Get Metadata of All Contact Custom Forms | Agency | contacts | Access token | GET /v4/contacts/{id}/customForms/meta | 7.3.3.4 |
| Get Metadata of a Contact Custom Form | Agency | contacts | Access token | GET /v4/contacts/{id}/customForms/{formId}/meta | 7.3.3.4 |
| Update Custom Form for Contact | Agency | contacts | Access token | PUT /v4/contacts/{id}/customForms | 7.3.3.4 |
Contacts/CustomTables
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Custom Tables for Contact | All | contacts | Access token | GET /v4/contacts/{contactId}/customTables | 7.3.3.4 |
| Get Metadata of All Contact Custom Tables | All | contacts | Access token | GET /v4/contacts/{contactId}/customTables/meta | 7.3.3.4 |
| Get Metadata of a Contact Custom Table | All | contacts | Access token | GET /v4/contacts/{contactId}/customTables/{tableId}/meta | 7.3.3.4 |
| Update Custom Table for Contact | All | contacts | Access token | PUT /v4/contacts/{contactId}/customTables | 7.3.3.4 |
Contacts/Records
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Records for Contact | All | contacts | Access token | GET /v4/contacts/{id}/records | 8.0.0 |
DocumentReview
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Attach Document Report | Agency | documents | Access token | POST /v4/documentReview/records/{recordId}/documents | 7.3.3.5 |
| Checkin Document Review | Agency | documents | Access token | POST /v4/documentReview/records/{recordId}/documents/{documentId}/checkin | 7.3.3.5 |
| Create Document Review Comments | Agency | documents | Access token | POST /v4/documentReview/documents/{documentId}/comments | 7.3.3.5 |
| Delete Document Review Comments | Agency | documents | Access token | DELETE /v4/documentReview/documents/{documentId}/comments/{commentIds} | 7.3.3.5 |
| Get Document Review Comments | Agency | documents | Access token | GET /v4/documentReview/documents/{documentId}/comments/{commentIds} | 7.3.3.5 |
| Update Document Review Comment | Agency | documents | Access token | PUT /v4/documentReview/documents/{documentId}/comments/{commentId} | 7.3.3.5 |
| Update Document Review Task Status | Agency | documents | Access token | PUT /v4/documentReview/documents/{documentId}/tasks/{id} | 7.3.3.5 |
Documents
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Download Document | All | documents | Access token | GET /v4/documents/{documentId}/download | 7.3.3.2 |
| Get Image Document Thumbnail | All | documents | Access token | GET /v4/documents/{documentId}/thumbnail | 7.3.2 |
| Get Documents | All | documents | Access token | GET /v4/documents/{documentIds} | 7.3.2 |
| Update Document | Agency | documents | Access token | PUT /v4/documents/{documentId} | 7.3.3 |
Filters
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Filters | Agency | filters | Access token | GET /v4/filters | 9.0.0 |
| Get Filter Results | Agency | filters | Access token | POST /v4/filters/{id}/results | 9.0.0 |
Geocoding
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Reverse Geocode Address | All | gis | No auth required | GET /v4/geo/geocode/reverse | All |
Inspections
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Assign Inspections | Agency | inspections | Access token | PUT /v4/inspections/{ids}/assign | 7.3.2 |
| Cancel Inspections | All | inspections | Access token | DELETE /v4/inspections/{ids}/cancel | 7.3.2 |
| Create Related Inspections | Agency | inspections | Access token | POST /v4/inspections/{id}/related | 7.3.2 |
| Delete Inspections | Agency | inspections | Access token | DELETE /v4/inspections/{ids} | 7.3.2 |
| Delete Related Inspections | Agency | inspections | Access token | DELETE /v4/inspections/{id}/related/{childIds} | 7.3.2 |
| Get All Available Dates for Inspection | All | inspections | Access token | GET /v4/inspections/availableDates | 7.3.2 |
| Get All Inspections | All | inspections | Access token | GET /v4/inspections | 7.3.2 |
| Get Inspection History | All | inspections | Access token | GET /v4/inspections/{inspectionIds}/histories | 7.3.2 |
| Get Inspections | All | inspections | Access token | GET /v4/inspections/{ids} | 7.3.2 |
| Get Related Inspections | All | inspections | Access token | GET /v4/inspections/{id}/related | 7.3.2 |
| Reschedule Inspection | All | inspections | Access token | PUT /v4/inspections/{id}/reschedule | 7.3.2 |
| Result Inspection | Agency | inspections | Access token | PUT /v4/inspections/{id}/result | 7.3.2 |
| Schedule Inspection | All | inspections | Access token | POST /v4/inspections/schedule | 7.3.2 |
| Schedule Pending Inspection | All | inspections | Access token | PUT /v4/inspections/{id}/schedule | 7.3.2 |
| Update Inspection | Agency | inspections | Access token | PUT /v4/inspections/{id} | 7.3.2 |
Inspections/Checklists
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Inspection Checklist | Agency | inspections | Access token | POST /v4/inspections/{inspectionId}/checklists | 7.3.2 |
| Delete Inspection Checklists | Agency | inspections | Access token | DELETE /v4/inspections/{inspectionId}/checklists/{ids} | 7.3.2 |
| Get All Checklists for Inspection | All | inspections | Access token | GET /v4/inspections/{inspectionId}/checklists | 7.3.2 |
Inspections/Checklists/ChecklistItems
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Checklist Items for Checklist | Agency | inspections | Access token | GET /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems | 7.3.2 |
| Get All Statuses for Checklist Item | All | inspections | Access token | GET /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/statuses | 7.3.2 |
| Get Checklist Item History | All | inspections | Access token | GET /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/histories | 7.3.2 |
| Update Inspection Checklist Items | Agency | inspections | Access token | PUT /v4/inspections/checklists/{id}/checklistItems | 7.3.2 |
Inspections/Checklists/ChecklistItems/CustomForms
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Custom Forms for Checklist Item | Agency | inspections | Access token | GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms | 7.3.2 |
| Get Metadata of All Checklist Item Custom Forms | Agency | inspections | Access token | GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms/meta | 7.3.2 |
| Get Metadata of a Checklist Item Custom Form | Agency | inspections | Access token | GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms/{formId}/meta | 7.3.2 |
| Update Custom Forms for Checklist Item | Agency | inspections | Access token | PUT /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms | 7.3.2 |
Inspections/Checklists/ChecklistItems/CustomTables
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Custom Tables for Checklist Item | Agency | inspections | Access token | GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables | 7.3.2 |
| Get Metadata of All Checklist Item Custom Tables | Agency | inspections | Access token | GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables/meta | 7.3.2 |
| Get Metadata of a Checklist Item Custom Table | Agency | inspections | Access token | GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables/{tableId}/meta | 7.3.2 |
| Get Custom Table for Checklist Item | Agency | inspections | Access token | GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables/{tableId} | 7.3.2 |
| Update Custom Tables for Checklist Item | Agency | inspections | Access token | PUT /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables | 7.3.2 |
Inspections/Checklists/ChecklistItems/Documents
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Checklist Item Documents | Agency | inspections | Access token | POST /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/documents | 7.3.2 |
| Get All Documents for Checklist Item | Agency | inspections | Access token | GET /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/documents | 7.3.2 |
Inspections/Comments
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Comments for Inspection | All | inspections | Access token | GET /v4/inspections/{inspectionId}/comments | 7.3.2 |
Inspections/ConditionApprovals
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Inspection Approval Conditions | Agency | inspections | Access token | POST /v4/inspections/{inspectionId}/conditionApprovals | 7.3.2 |
| Delete Inspection Approval Conditions | Agency | inspections | Access token | DELETE /v4/inspections/{inspectionId}/conditionApprovals/{ids} | 7.3.2 |
| Get All Approval Conditions for Inspection | All | inspections | Access token | GET /v4/inspections/{inspectionId}/conditionApprovals | 7.3.2 |
| Get Inspection Approval Condition | All | inspections | Access token | GET /v4/inspections/{inspectionId}/conditionApprovals/{id} | 7.3.2 |
| Update Inspection Approval Condition | Agency | inspections | Access token | PUT /v4/inspections/{inspectionId}/conditionApprovals/{id} | 7.3.2 |
Inspections/Conditions
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Inspection Standard Conditions | Agency | inspections | Access token | POST /v4/inspections/{inspectionId}/conditions | 7.3.2 |
| Delete Inspection Conditions | Agency | inspections | Access token | DELETE /v4/inspections/{inspectionId}/conditions/{ids} | 7.3.2 |
| Get All Standard Conditions for Inspection | All | inspections | Access token | GET /v4/inspections/{inspectionId}/conditions | 7.3.2 |
| Get Inspection Condition | All | inspections | Access token | GET /v4/inspections/{inspectionId}/conditions/{id} | 7.3.2 |
| Get Inspection Condition History | All | inspections | Access token | GET /v4/inspections/{inspectionId}/conditions/{id}/histories | 7.3.2 |
| Update Inspection Condition | Agency | inspections | Access token | PUT /v4/inspections/{inspectionId}/conditions/{id} | 7.3.2 |
Inspections/Documents
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Inspection Documents | All | inspections | Access token | POST /v4/inspections/{inspectionId}/documents | 7.3.2 |
| Delete Inspection Documents | Agency | inspections | Access token | DELETE /v4/inspections/{inspectionId}/documents/{ids} | 7.3.2 |
| Get All Documents for Inspection | All | inspections | Access token | GET /v4/inspections/{inspectionId}/documents | 7.3.2 |
Inspections/TimeAccounting
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Inspection Time Accounting Entry | Agency | inspections | Access token | POST /v4/inspections/{inspectionId}/timeAccounting | 7.3.2 |
| Delete Inspection Time Accounting Entries | Agency | inspections | Access token | DELETE /v4/inspections/{inspectionId}/timeAccounting/{ids} | 7.3.2 |
| Get All Time Accounting Entries for Inspection | Agency | inspections | Access token | GET /v4/inspections/{inspectionId}/timeAccounting | 7.3.2 |
| Update Inspection Time Accounting Entry | Agency | inspections | Access token | PUT /v4/inspections/{inspectionId}/timeAccounting/{id} | 7.3.2 |
Inspectors
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Inspectors | Agency | inspections | Access token | GET /v4/inspectors | 7.3.2 |
| Get Inspector | Agency | inspectors | Access token | GET /v4/inspectors/{id} | 7.3.2 |
Invoices
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get Invoices | Agency | invoices | Access token | GET /v4/invoices/{invoiceIds} | 9.0.0 |
Mileage
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Mileage | Agency | mileage | Access token | POST /v4/mileage | 7.3.3 |
Owners
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Owner Conditions | All | owners | Access token | GET /v4/owners/{ownerId}/conditions | 8.0.0 |
| Get All Owners | All | owners | Access token | GET /v4/owners | 7.3.2 |
| Get Owner | All | owners | Access token | GET /v4/owners/{id} | 7.3.2 |
Parcels
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Parcel Addresses | All | parcels | No auth required | GET /v4/parcels/{id}/addresses | 7.3.2 |
| Get All Parcel Conditions | All | parcels | Access token | GET /v4/parcels/{parcelId}/conditions | 8.0.0 |
| Get All Parcel Owners | All | parcels | No auth required | GET /v4/parcels/{parcelId}/owners | 7.3.2 |
| Get All Parcels | All | parcels | No auth required | GET /v4/parcels | 7.3.2 |
| Get Parcel | All | parcels | No auth required | GET /v4/parcels/{id} | 7.3.2 |
Payments
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Initialize Payment | Citizen | payments | Access token | POST /V4/payments/initialize | 7.3.3.5 |
| Commit Payment | Citizen | payments | Access token | PUT /V4/payments/{id} | 7.3.3.5 |
| Get All Fee Schedules | All | payments | Access token | GET /v4/settings/fees | 7.3.2 |
| Void Payment | Agency | payments | Access token | PUT /v4/payments/{paymentId}/void | 9.0.0 |
Professionals
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Professional Conditions | All | professionals | Access token | GET /v4/professionals/{id}/conditions | 8.0.0 |
| Get All Professional Records | All | professionals | Access token | GET /v4/professionals/{id}/records | 7.3.2 |
| Get All Professionals | All | professionals | Access token | GET /v4/professionals | 7.3.2 |
| Get Professionals | All | professionals | Access token | GET /v4/professionals/{ids} | 7.3.2 |
Records
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Partial Record | All | records | No auth required | POST /v4/records/initialize | 7.3.2 |
| Create Record | All | records | Access token | POST /v4/records | 7.3.2 |
| Create Record User Comments (Deprecated in V4) | Citizen | records | Access token | POST /v4/records/{recordId}/usercomments | 7.3.2 |
| Create Record Votes | Citizen | records | Access token | POST /v4/records/{recordId}/votes | 7.3.2 |
| Create Related Details for Record | All | records | Access token | POST /v4/records/{recordId}/related | 7.3.2 |
| Delete Records | All | records | Access token | DELETE /v4/records/{ids} | 7.3.3 |
| Delete Related Details from Record | Agency | records | Access token | DELETE /v4/records/{recordId}/related/{childRecordIds} | 7.3.2 |
| Describe Required Record Attributes | All | records | Access token | GET /v4/records/describe/create | 7.3.2 |
| Finalize Record | All | records | Access token | POST /v4/records/{recordId}/finalize | 7.3.2 |
| Get Additional Details for Record | All | records | Access token | GET /v4/records/{recordId}/additional | 7.3.2 |
| Get All Records | All | records | No auth required | GET /v4/records | 7.3.2 |
| Get All Related Details for Record | All | records | Access token | GET /v4/records/{recordId}/related | 7.3.2 |
| Get All User Comments for Record (Deprecated in V4) | Citizen | records | Access token | GET /v4/records/{recordId}/usercomments | 7.3.2 |
| Get All Votes for Record | Citizen | records | Access token | GET /v4/records/{recordId}/votes | 7.3.2 |
| Get My Records | All | records | Access token | GET /v4/records/mine | 7.3.2 |
| Get Record Votes Summary | All | records | Access token | GET /v4/records/{recordId}/votes/summary | 7.3.2 |
| Get Records | All | records | No auth required | GET /v4/records/{ids} | 7.3.2 |
| Update Additional Details for Record | All | records | Access token | PUT /v4/records/{recordId}/additional | 7.3.2 |
| Update Record | All | records | Access token | PUT /v4/records/{id} | 7.3.2 |
Records/Activities
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Record Activities | Agency | records | Access token | POST /v4/records/{recordId}/activities | 7.3.3.2 |
| Get All Record Activities | Agency | records | Access token | GET /v4/records/{recordId}/activities | 7.3.3.2 |
| Update Record Activity | Agency | records | Access token | PUT /v4/records/{recordId}/activities/{id} | 7.3.3.2 |
Records/Addresses
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Record Addresses | All | records | Access token | POST /v4/records/{recordId}/addresses | 7.3.2 |
| Delete Record Addresses | All | records | Access token | DELETE /v4/records/{recordId}/addresses/{ids} | 7.3.2 |
| Get All Addresses for Record | All | records | No auth required | GET /v4/records/{recordId}/addresses | 7.3.2 |
| Update Record Address | All | records | Access token | PUT /v4/records/{recordId}/addresses/{id} | 7.3.2 |
Records/Assets
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Add Assets to Record | Agency | records | Access token | POST /v4/records/{recordId}/assets | 9.0.0 |
| Delete Assets from Record | Agency | records | Access token | DELETE /v4/records/{recordId}/assets/{ids} | 9.0.0 |
| Get All Record Assets | Agency | records | Access token | GET /v4/records/{recordId}/assets | 9.0.0 |
Records/Comments
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Record Comments | Agency | records | Access token | POST /v4/records/{recordId}/comments | 7.3.2 |
| Delete Record Comments | Agency | records | Access token | DELETE /v4/records/{recordId}/comments/{ids} | 7.3.2 |
| Get All Comments for Record | All | records | Access token | GET /v4/records/{recordId}/comments | 7.3.2 |
| Update Record Comment | Agency | records | Access token | PUT /v4/records/{recordId}/comments/{id} | 7.3.2 |
Records/ConditionApprovals
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Record Approval Conditions | Agency | records | Access token | POST /v4/records/{recordId}/conditionApprovals | 7.3.2 |
| Delete Record Approval Conditions | Agency | records | Access token | DELETE /v4/records/{recordId}/conditionApprovals/{ids} | 7.3.2 |
| Get All Approval Conditions for Record | All | records | Access token | GET /v4/records/{recordId}/conditionApprovals | 7.3.2 |
| Get Record Approval Condition | All | records | Access token | GET /v4/records/{recordId}/conditionApprovals/{id} | 7.3.2 |
| Update Record Approval Condition | Agency | records | Access token | PUT /v4/records/{recordId}/conditionApprovals/{id} | 7.3.3.2 |
Records/Conditions
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Record Conditions | Agency | records | Access token | POST /v4/records/{recordId}/conditions | 7.3.2 |
| Delete Record Conditions | Agency | records | Access token | DELETE /v4/records/{recordId}/conditions/{ids} | 7.3.2 |
| Get All Conditions for Record | All | records | Access token | GET /v4/records/{recordId}/conditions | 7.3.2 |
| Get Record Condition | All | records | Access token | GET /v4/records/{recordId}/conditions/{id} | 7.3.2 |
| Update Record Condition | Agency | records | Access token | PUT /v4/records/{recordId}/conditions/{id} | 7.3.2 |
| Get History for Record Condition | All | records | Access token | GET /v4/records/{recordId}/conditions/{id}/histories | 9.0.0 |
Records/Contacts
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Record Contact Addresses | All | records | Access token | POST /v4/records/{recordId}/contacts/{contactId}/addresses | 7.3.2 |
| Create Record Contacts | All | records | Access token | POST /v4/records/{recordId}/contacts | 7.3.2 |
| Delete Record Contact Addresses | All | records | Access token | DELETE /v4/records/{recordId}/contacts/{contactId}/addresses/{ids} | 7.3.2 |
| Delete Record Contacts | All | records | Access token | DELETE /v4/records/{recordId}/contacts/{ids} | 7.3.2 |
| Get All Addresses for Record Contact | All | records | Access token | GET /v4/records/{recordId}/contacts/{contactId}/addresses | 7.3.2 |
| Get All Contacts for Record | All | records | Access token | GET /v4/records/{recordId}/contacts | 7.3.2 |
| Get Record Contacts Custom Forms | All | records | Access token | GET /v4/records/{recordId}/contacts/{contactId}/customForms | 7.3.2 |
| Get Record Contacts Custom Forms Meta | All | records | Access token | GET /v4/records/{recordId}/contacts/{contactId}/customForms/meta | 7.3.2 |
| Update Record Contact | All | records | Access token | PUT /v4/records/{recordId}/contacts/{id} | 7.3.2 |
| Update Record Contact Address | All | records | Access token | PUT /v4/records/{recordId}/contacts/{contactId}/addresses/{id} | 7.3.2 |
| Update Record Contact Custom Forms | All | records | Access token | PUT /v4/records/{recordId}/contacts/{contactId}/customForms | 7.3.2 |
Records/Contacts/CustomTables
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Custom Tables for Record Contact | Agency | records | Access token | GET /v4/records/{recordId}/contacts/{contactId}/customTables?fields={fields}&lang={lang} | 8.0.3 |
| Get Metadata of a Record Contact Custom Table | Agency | records | Access token | GET /v4/records/{recordId}/contacts/{contactId}/customTables/{tableId}/meta | 8.0.3 |
| Get Metadata of All Record Contact Custom Tables | Agency | records | Access token | GET /v4/records/{recordId}/contacts/{contactId}/customTables/meta | 8.0.3 |
| Update Record Contact Custom Tables | Agency | records | Access token | PUT /v4/records/{recordId}/contacts/{contactId}/customTables | 8.0.3 |
Records/Costs
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Delete Record Costs | All | records | Access token | DELETE /v4/records/{recordId}/costs/{ids} | 9.0.0 |
| Get Record Costs | All | records | Access token | GET /v4/records/{recordId}/costs | 9.0.0 |
Records/CustomForms
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Custom Forms for Record | All | records | No auth required | GET /v4/records/{recordId}/customForms | 7.3.2 |
| Get Metadata of All Record Custom Forms | All | records | No auth required | GET /v4/records/{recordId}/customForms/meta | 7.3.2 |
| Get Metadata of a Record Custom Form | All | records | No auth required | GET /v4/records/{recordId}/customForms/{formId}/meta | 7.3.2 |
| Update Record Custom Forms | All | records | Access token | PUT /v4/records/{recordId}/customForms | 7.3.2 |
Records/CustomTables
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Custom Tables for Record | All | records | No auth required | GET /v4/records/{recordId}/customTables | 7.3.2 |
| Get Metadata of All Record Custom Tables | All | records | No auth required | GET /v4/records/{recordId}/customTables/meta | 7.3.2 |
| Get Metadata of a Record Custom Table | All | records | No auth required | GET /v4/records/{recordId}/customTables/{tableId}/meta | 7.3.2 |
| Get Record Custom Table | All | records | No auth required | GET /v4/records/{recordId}/customTables/{tableId} | 7.3.2 |
| Update Record Custom Tables | All | records | Access token | PUT /v4/records/{recordId}/customTables | 7.3.2 |
Records/Documents
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Record Documents | All | records | Access token | POST /v4/records/{recordId}/documents | 7.3.2 |
| Delete Record Documents | All | records | Access token | DELETE /v4/records/{recordId}/documents/{documentIds} | 7.3.2 |
| Get All Document Categories for Record | All | records | Access token | GET /v4/records/{recordId}/documentCategories | 7.3.2 |
| Get All Documents for Record | All | records | Access token | GET /v4/records/{recordId}/documents | 7.3.2 |
Records/Fees
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Record Fees | Agency | records | Access token | POST /v4/records/{recordId}/fees | 7.3.2 |
| Estimate Record Fees | All | records | Access token | PUT /v4/records/{recordId}/fees/estimate | 7.3.3 |
| Get All Fees for Record | All | records | Access token | GET /v4/records/{recordId}/fees | 7.3.2 |
Records/Invoices
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Record Invoice | All | records | Access token | POST /v4/records/{recordId}/invoices | 7.3.3.2 |
| Get All Record Invoices | Agency | records | Access token | GET /v4/records/{recordId}/invoices | 9.0.0 |
Records/Inspections
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Inspection Types for Record | All | records | Access token | GET /v4/records/{recordIds}/inspectionTypes | 7.3.2 |
| Get All Inspections for Record | All | records | Access token | GET /v4/records/{recordId}/inspections | 7.3.2 |
Records/Owners
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Record Owners | All | records | Access token | POST /v4/records/{recordId}/owners | 7.3.2 |
| Delete Record Owners | All | records | Access token | DELETE /v4/records/{recordId}/owners/{ids} | 7.3.2 |
| Get All Owners for Record | All | records | Access token | GET /v4/records/{recordId}/owners | 7.3.2 |
| Update Record Owner | All | records | Access token | PUT /v4/records/{recordId}/owners/{id} | 7.3.2 |
Records/Parcels
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Record Parcels | All | records | No auth required | POST /v4/records/{recordId}/parcels | 7.3.2 |
| Delete Record Parcels | All | records | Access token | DELETE /v4/records/{recordId}/parcels/{ids} | 7.3.2 |
| Get All Parcels for Record | All | records | No auth required | GET /v4/records/{recordId}/parcels | 7.3.2 |
| Update Record Parcel | All | records | Access token | PUT /v4/records/{recordId}/parcels/{id} | 7.3.2 |
Records/PartTransaction
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Record Part Transaction | All | records | Access token | POST /v4/records/{recordId}/partTransaction | 7.3.3 |
| Get Record Part Transaction | All | records | Access token | GET /v4/records/{recordId}/partTransaction | 7.3.3 |
| Void Record Part Transactions | All | records | Access token | DELETE /v4/records/{recordId}/partTransaction/{ids} | 7.3.3 |
Records/Payments
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get Record Payment | All | records | Access token | GET /v4/records/{recordId}/payments/{paymentId} | 7.3.2 |
| Get All Payments for Record | All | records | Access token | GET /v4/records/{recordId}/payments | 9.0.0 |
Records/Professionals
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Record Professionals | All | records | Access token | POST /v4/records/{recordId}/professionals | 7.3.2 |
| Delete Record Professionals | All | records | Access token | DELETE /v4/records/{recordId}/professionals/{ids} | 7.3.2 |
| Get All Professionals for Record | All | records | Access token | GET /v4/records/{recordId}/professionals | 7.3.2 |
| Update Record Professional | All | records | Access token | PUT /v4/records/{recordId}/professionals/{id} | 7.3.2 |
Records/TrustAccounts
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Trust Accounts for Record | All | records | Access token | GET /v4/records/{recordId}/trustAccounts | 7.3.3.4 |
Records/WorkflowTasks
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Statuses for Workflow Task | All | records | Access token | GET /v4/records/{recordId}/workflowTasks/{id}/statuses | 7.3.2 |
| Get All Workflow Task History for Record | All | records | Access token | GET /v4/records/{recordId}/workflowTasks/histories | 7.3.2 |
| Get All Workflow Tasks for Record | All | records | Access token | GET /v4/records/{recordId}/workflowTasks | 7.3.2 |
| Get Record Workflow Task | All | records | Access token | GET /v4/records/{recordId}/workflowTasks/{id} | 7.3.2 |
| Get Workflow Task Comment Histories | All | records | Access token | GET /v4/records/{recordId}/workflowTasks/comments/histories | 7.3.2 |
| Update Record Workflow Task | Agency | records | Access token | PUT /v4/records/{recordId}/workflowTasks/{id} | 7.3.2 |
Records/WorkflowTasks/CustomForms
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Custom Forms for Record Workflow Task | All | records | Access token | GET /v4/records/{recordId}/workflowTasks/{taskId}/customForms | 8.0.3 |
| Get Metadata of All Custom Forms for Record Workflow Task | Agency | records | Access token | GET /v4/records/{recordId}/workflowTasks/{taskId}/customForms/meta | 8.0.3 |
| Update Custom Forms for Record Workflow Task | Agency | records | Access token | PUT /v4/records/{recordId}/workflowTasks/{taskId}/customForms | 8.0.3 |
Reports
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Report | All | reports | Access token | POST /v4/reports/{reportId} | 7.3.2 |
| Get All Report Categories | All | reports | Access token | GET /v4/settings/reports/categories | 7.3.2 |
| Get All Report Definitions | All | reports | Access token | GET /v4/settings/reports/definitions | 7.3.2 |
| Get Report Definition | All | reports | Access token | GET /v4/settings/reports/definitions/{reportId} | 7.3.2 |
Searches
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Search Addresses | All | addresses | No auth required | POST /v4/search/addresses | 7.3.2 |
| Search Agencies | All | agencies | No auth required | POST /v4/search/agencies | 7.3.1 |
| Search All | All | global_search | Access token | GET /v4/search/global | 7.3.2 |
| Search Assessments | Agency | assessments | Access token | POST /v4/search/assessments | 9.0.0 |
| Search Contacts | All | contacts | Access token | POST /v4/search/contacts | 7.3.2 |
| Search Costs | Agency | costs | Access token | POST /v4/search/costs | 7.3.3.2 |
| Search Inspections | All | inspections | Access token | POST /v4/search/inspections | 7.3.2 |
| Search Owners | All | owners | Access token | POST /v4/search/owners | 7.3.2 |
| Search Parcels | All | parcels | No auth required | POST /v4/search/parcels | 7.3.2 |
| Search Parts | Agency | parts | Access token | POST /v4/search/parts | 7.3.3.2 |
| Search Professionals | All | professionals | Access token | POST /v4/search/professionals | 7.3.2 |
| Search Records | All | records | No auth required | POST /v4/search/records | 7.3.2 |
Settings/Activities
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Activity Priorities | Agency | settings | Access token | GET /v4/settings/activities/priorities | 7.3.3 |
| Get All Activity Statuses | Agency | settings | Access token | GET /v4/settings/activities/statuses | 7.3.3 |
| Get All Activity Types | Agency | settings | Access token | GET /v4/settings/activities/types | 7.3.3 |
Settings/Addresses
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Address Countries | All | addresses | Access token | GET /v4/settings/addresses/countries | 7.3.2 |
| Get All Address States | All | addresses | Access token | GET /v4/settings/addresses/states | 7.3.2 |
| Get All Address Street Directions | All | addresses | Access token | GET /v4/settings/addresses/streetDirections | 7.3.2 |
| Get All Address Street Fractions | All | addresses | Access token | GET /v4/settings/addresses/streetFractions | 7.3.2 |
| Get All Address Street Suffixes | All | addresses | Access token | GET /v4/settings/addresses/streetSuffixes | 7.3.2 |
| Get All Address Unit Types | All | addresses | Access token | GET /v4/settings/addresses/unitTypes | 7.3.2 |
Settings/Agencies
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Department Staff | Agency | settings | Access token | GET /v4/settings/departments/{id}/staffs | 7.3.2 |
| Get All Departments | Agency | settings | Access token | GET /v4/settings/departments | 7.3.2 |
Settings/Assessments
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Condition Assessment Types | Agency | assessments | Access token | GET /v4/settings/assessments/types | 9.0.0 |
Settings/Assets
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Asset Groups | Agency | assets | Access token | GET /v4/settings/assets/groups | 9.0.0 |
| Get All Asset Size Units | Agency | assets | Access token | GET /v4/settings/assets/sizeUnits | 9.0.0 |
| Get All Asset Statuses | Agency | assets | Access token | GET /v4/settings/assets/statuses | 9.0.0 |
Settings/AssetTypes
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Asset Class Types | Agency | assets | Access token | GET /v4/settings/assettypes/classTypes | 9.0.0 |
| Get All Asset Rating Types | Agency | assets | Access token | GET /v4/settings/assettypes/ratingTypes | 9.0.0 |
| Get All Asset Record Types | Agency | settings | Access token | GET /v4/settings/assettypes/recordtypes | 9.0.0 |
| Get All Asset Types | Agency | assets | Access token | GET /v4/settings/assettypes/types | 9.0.0 |
| Get All Asset Usage Types | Agency | assets | Access token | GET /v4/settings/assettypes/usageTypes | 9.0.0 |
Settings/Comments
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Standard Comment Groups | Agency | settings | Access token | GET /v4/settings/comments/groups | 7.3.2 |
| Get All Standard Comments | Agency | settings | Access token | GET /v4/settings/comments | 7.3.2 |
Settings/ConditionApprovals
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Approval Condition Statuses | Agency | conditions | Access token | GET /v4/settings/conditionApprovals/statuses | 7.3.2 |
Settings/Conditions
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Standard Condition Statuses | Agency | conditions | Access token | GET /v4/settings/conditions/statuses | 7.3.2 |
| Get All Standard Condition Types | Agency | conditions | Access token | GET /v4/settings/conditions/types | 7.3.2 |
| Get All Standard Conditon Priorities | Agency | conditions | Access token | GET /v4/settings/conditions/priorities | 7.3.2 |
Settings/Contacts
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Contact Preferred Channels | All | contacts | Access token | GET /v4/settings/contacts/preferredChannels | 7.3.2 |
| Get All Contact Races | All | contacts | Access token | GET /v4/settings/contacts/races | 7.3.2 |
| Get All Contact Relations | All | contacts | Access token | GET /v4/settings/contacts/relations | 7.3.2 |
| Get All Contact Salutations | All | contacts | Access token | GET /v4/settings/contacts/salutations | 7.3.2 |
| Get All Contact Types | All | contacts | Access token | GET /v4/settings/contacts/types | 7.3.2 |
| Get All Custom Form Settings for Contact Type | All | settings | Access token | GET /v4/settings/contacts/types/{id}/customForms | 7.3.2 |
| Get All Custom Table Settings for Contact Type | Agency | settings | Access token | GET /v4/settings/contacts/types/{id}/customTables | 8.0.3 |
Settings/Costs
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Cost Accounts | Agency | settings | Access token | GET /v4/settings/costs/accounts | 7.3.3 |
| Get All Cost Factors | Agency | settings | Access token | GET /v4/settings/costs/factors | 7.3.3 |
| Get All Cost Type Items | Agency | settings | Access token | GET /v4/settings/costs/types/{typeName}/items | 7.3.3 |
| Get All Cost Types | Agency | settings | Access token | GET /v4/settings/costs/types | 7.3.3 |
| Get All Cost Unit Types | Agency | settings | Access token | GET /v4/settings/costs/unitTypes | 7.3.3 |
Settings/Documents
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Folders | Agency | documents | Access token | POST /v4/settings/documents/folders | 7.3.3 |
| Delete Folders | Agency | documents | Access token | DELETE /v4/settings/documents/folders/{ids} | 7.3.3 |
| Get All Document Categories | All | documents | Access token | GET /v4/settings/documents/categories | 7.3.2 |
| Get All Folder Groups | Agency | documents | Access token | GET /v4/settings/documents/folderGroups | 7.3.3 |
| Get Folder Group | Agency | documents | Access token | GET /v4/settings/documents/folders/{groupId} | 7.3.3 |
| Update Folder Groups | Agency | documents | Access token | PUT /v4/settings/documents/folderGroups | 7.3.3 |
| Update Folders | Agency | documents | Access token | PUT /v4/settings/documents/folders | 7.3.3 |
Settings/Drilldowns
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get Drilldown Settings | All | settings | No auth required | GET /v4/settings/drillDowns/{drillId} | 7.3.2 |
Settings/Inspections
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Custom Form Settings for Checklist Item | Agency | inspections | Access token | GET /v4/settings/inspections/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms | 7.3.2 |
| Get All Custom Table Settings for Checklist Item | Agency | inspections | Access token | GET /v4/settings/inspections/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables | 7.3.2 |
| Get All Inspection Checklist Groups | Agency | inspections | Access token | GET /v4/settings/inspections/checklistsGroups | 7.3.2 |
| Get All Inspection Checklists | Agency | inspections | Access token | GET /v4/settings/inspections/checklists | 7.3.2 |
| Get All Inspection Grades | All | inspections | Access token | GET /v4/settings/inspections/grades | 7.3.2 |
| Get All Inspection Statuses | All | inspections | Access token | GET /v4/settings/inspections/statuses | 7.3.2 |
| Get All Inspection Types | All | inspections | Access token | GET /v4/settings/inspections/types | 7.3.2 |
| Get Inspection Checklist Statuses | All | inspections | Access token | GET /v4/settings/inspections/checklists/statuses | 7.3.3 |
| Get Inspection Checklists | Agency | inspections | Access token | GET /v4/settings/inspections/checklists/{ids} | 7.3.2 |
| Get Inspection Types | All | inspections | Access token | GET /v4/settings/inspections/types/{ids} | 7.3.2 |
Settings/Modules
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Modules | All | settings | Access token | GET /v4/settings/modules | 7.3.2 |
Settings/Parts
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Part Locations | ALL | settings | No auth required | GET /v4/settings/parts/locations | 7.3.3 |
| Get Part Types | Agency | settings | Access token | GET /v4/settings/parts/types | 7.3.3 |
Settings/Payments
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Payment Refund Reasons | All | settings | Access token | GET /v4/settings/payments/refundReasons | 9.0.0 |
| Get All Payment Void Reasons | All | settings | Access token | GET /v4/settings/payments/voidReasons | 9.0.0 |
Settings/PickLists
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Pick Lists | All | settings | Access token | GET /v4/settings/pickLists | 7.3.3 |
| Get Pick List | All | settings | Access token | GET /v4/settings/pickLists/{id} | 7.3.3 |
Settings/Priorities
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Priorities | All | settings | Access token | GET /v4/settings/priorities | 7.3.2 |
Settings/Professionals
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Professional License Boards | All | professionals | Access token | GET /v4/settings/professionals/licenseBoards | 7.3.2 |
| Get All Professional License Types | All | professionals | Access token | GET /v4/settings/professionals/types | 7.3.2 |
| Get All Professional Salutations | All | professionals | Access token | GET /v4/settings/professionals/salutations | 7.3.2 |
Settings/Records
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Asset Types for Record Type | Agency | records | Access token | GET /v4/settings/records/types/{recordTypeId}/assetTypes | 9.0.0 |
| Get All Custom Forms for Record Type | All | records | No auth required | GET /v4/settings/records/types/{id}/customForms | 7.3.2 |
| Get All Custom Tables for Record Type | All | records | No auth required | GET /v4/settings/records/types/{id}/customTables | 7.3.2 |
| Get All Fee Schedules for Record Type | All | records | Access token | GET /v4/settings/records/types/{id}/fees/schedules | 7.3.2 |
| Get All Record Construction Types | All | records | Access token | GET /v4/settings/records/constructionTypes | 7.3.2 |
| Get All Record Expiration Statuses | All | records | Access token | GET /v4/settings/records/expirationStatuses | 7.3.2 |
| Get All Record Types | All | records | No auth required | GET /v4/settings/records/types | 7.3.3.2 |
| Get All Statuses for Record Type | All | records | Access token | GET /v4/settings/records/types/{id}/statuses | 7.3.2 |
Settings/TimeAccounting
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Time Accounting Groups | All | settings | No auth required | GET /v4/settings/timeAccounting/groups | 7.3.2 |
| Get All Time Accounting Types | All | settings | No auth required | GET /v4/settings/timeAccounting/types | 7.3.2 |
ShoppingCarts
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Shopping Cart | Citizen | shoppingcart | Access token | POST /v4/shoppingCart | 7.3.3 |
| Delete Shopping Carts | Citizen | shoppingcart | Access token | DELETE /v4/shoppingCart/{ids} | 7.3.3 |
| Get All Shopping Carts | Citizen | shoppingcart | Access token | GET /v4/shoppingCart | 7.3.3 |
| Get Shopping Carts | Citizen | shoppingcart | Access token | GET /v4/shoppingCart/{ids} | 7.3.3 |
| Update Shopping Cart | Citizen | shoppingcart | Access token | PUT /v4/shoppingCart/{id} | 7.3.3 |
TimeAccounting
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Time Accounting | Agency | timeaccounting | Access token | POST /v4/timeAccounting | 7.3.3 |
| Delete Time Accounting | Agency | timeaccounting | Access token | DELETE /v4/timeAccounting/{ids} | 7.3.3 |
| Get Time Accounting | Agency | timeaccounting | Access token | GET /v4/timeAccounting | 7.3.3 |
| Update Time Accounting | Agency | timeaccounting | Access token | PUT /v4/timeAccounting/{id} | 7.3.3 |
TrustAccounts
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Trust Accounts | All | trustaccounts | Access token | GET /v4/trustAccounts | 7.3.3.4 |
Users
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All User Groups | Agency | users | Access token | GET /v4/users/{user_id}/groups | 9.0.0 |
| Get My User Account | Agency | users | Access token | GET /v4/users/me | 9.0.0 |
Workflow
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get My Workflow Tasks | Agency | workflows | Access token | GET /v4/workflowTasks/mine | 7.3.2 |