Accela Records API

openapi: 3.2.0
info:
  description: Accela API for transactional records and related record resources
  title: Records API
  version: v4
servers:
- url: https://apis.accela.com/
tags:
- name: Records
  description: A record is a fundamental Civic Platform object that captures an agency's daily process tranactions, such as applications, permits, cases, licenses, service requests, and work orders.
paths:
  /v4/records:
    get:
      description: 'Gets record information, based on the specified query parameters.


        **API Endpoint**: GET /v4/records


        **Scope**: records


        **App Type**: All


        **Authorization Type**: No authorization required


        **Civic Platform version**: 7.3.2'
      summary: Get All Records
      operationId: v4.get.records
      tags:
      - Records
      parameters:
      - description: Filter by record type. See [Get All Record Types](./api-settings.html#operation/v4.get.settings.records.types).
        in: query
        name: type
        schema:
          type: string
      - description: Filter by the record's open date range, beginning with this date.
        in: query
        name: openedDateFrom
        schema:
          type: string
      - description: Filter by the record's open date range, ending with this date.
        in: query
        name: openedDateTo
        schema:
          type: string
      - description: Filter by the record custom id.
        in: query
        name: customId
        schema:
          type: string
      - description: Filter by module. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        in: query
        name: module
        schema:
          type: string
      - description: Filter by record status.
        in: query
        name: status
        schema:
          type: string
      - description: Filter by the assigned department.
        in: query
        name: assignedToDepartment
        schema:
          type: string
      - description: Filter by the assigned user.
        in: query
        name: assignedUser
        schema:
          type: string
      - description: Filter by the record's assigned date range starting with this date.
        in: query
        name: assignedDateFrom
        schema:
          type: string
      - description: Filter by the record's assigned date range ending with this date.
        in: query
        name: assignedDateTo
        schema:
          type: string
      - description: Filter by the record's completed date range starting with this date.
        in: query
        name: completedDateFrom
        schema:
          type: string
      - description: Filter by the record's completed date range ending with this date.
        in: query
        name: completedDateTo
        schema:
          type: string
      - description: Filter by the record's status date range starting with this date.
        in: query
        name: statusDateFrom
        schema:
          type: string
      - description: Filter by the record's status date range ending with this date.
        in: query
        name: statusDateTo
        schema:
          type: string
      - description: Filter by the deparment which completed the application.
        in: query
        name: completedByDepartment
        schema:
          type: string
      - description: Filter by the user who completed the application.
        in: query
        name: completedByUser
        schema:
          type: string
      - description: Filter by the record's closed date range starting with this date.
        in: query
        name: closedDateFrom
        schema:
          type: string
      - description: Filter by the record's closed date range ending with this date.
        in: query
        name: closedDateTo
        schema:
          type: string
      - description: Filter by the department which closed the application.
        in: query
        name: closedByDepartment
        schema:
          type: string
      - description: Filter by the user who closed the application.
        in: query
        name: closedByUser
        schema:
          type: string
      - description: Filter by record class
        in: query
        name: recordClass
        schema:
          type: string
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_simpleRecordModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: 'Creates a new, full record in Civic Platform. The Create Record API triggers the business rules engine event ApplicationSubmitAfter.


        Note: The Create Record API does not include custom forms and custom tables in the request body. To add or update custom forms and custom tables, use the Update Record Custom Forms and Update Record Custom Tables after the Create Record request.


        **API Endpoint**: POST /v4/records


        **Scope**: records


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      summary: Create Record
      operationId: v4.post.records
      tags:
      - Records
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_simpleRecordModel'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/request_createRecordModel'
        description: The create record information to be added.
  /v4/records/describe/create:
    get:
      tags:
      - Records
      summary: Describe Required Record Attributes
      description: 'Gets the field and element values the system requires in order to create a specific type of record.


        **API Endpoint**: GET /v4/records/describe/create


        **Scope**: records


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      operationId: v4.get.records.describe.create
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - description: Filter by record type. See [Get All Record Type](./api-settings.html#operation/v4.get.settings.records.types).
        in: query
        name: type
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_describeRecordModel'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/initialize:
    post:
      tags:
      - Records
      summary: Create Partial Record
      description: 'Creates a partial record that allows a user to save an incomplete application that is work in-progress. To submit the completed application, use the Finalize Record method. See Creating Records for more information about calling Create Partial Record in tandem with Finalize Record.


        The Create Partial Record API triggers the business rules engine event ApplicationSubmitAfter.


        Note: The Create Partial Record API does not include custom forms and custom tables in the request body. To add or update custom forms and custom tables, use the Update Record Custom Forms and Update Record Custom Tables between the Create Partial Record and Finalize Record requests.


        **API Endpoint**: POST /v4/records/initialize


        **Scope**: records


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      operationId: v4.post.records.initialize
      parameters:
      - description: Indicates whether or not it is for a fee estimate.
        in: query
        name: isFeeEstimate
        required: false
        schema:
          type: boolean
          enum:
          - 'true'
          - ' false'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_simpleRecordModel'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/request_recordModel'
        description: The record information to be initialized.
        required: true
  /v4/records/mine:
    get:
      description: 'Gets records for the currently logged-in user.


        **API Endpoint**: GET /v4/records/mine


        **Scope**: records


        **App Type**: All


        **Authorization Type**: No authorization required


        **Civic Platform version**: 7.3.2'
      summary: Get My Records
      operationId: v4.get.records.mine
      tags:
      - Records
      parameters:
      - description: Filter by record type. See [Get All Record Types](./api-settings.html#operation/v4.get.settings.records.types).
        in: query
        name: type
        schema:
          type: string
      - description: Filter by the record's open date range, beginning with this date.
        in: query
        name: openedDateFrom
        schema:
          type: string
      - description: Filter by the record's open date range, ending with this date.
        in: query
        name: openedDateTo
        schema:
          type: string
      - description: Filter by the record custom id.
        in: query
        name: customId
        schema:
          type: string
      - description: Filter by module. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        in: query
        name: module
        schema:
          type: string
      - description: Filter by record status.
        in: query
        name: status
        schema:
          type: string
      - description: Filter by the record's assigned date range starting with this date.
        in: query
        name: assignedDateFrom
        schema:
          type: string
      - description: Filter by the record's assigned date range ending with this date.
        in: query
        name: assignedDateTo
        schema:
          type: string
      - description: Filter by the record's completed date range starting with this date.
        in: query
        name: completedDateFrom
        schema:
          type: string
      - description: Filter by the record's completed date range ending with this date.
        in: query
        name: completedDateTo
        schema:
          type: string
      - description: Filter by the record's status date range starting with this date.
        in: query
        name: statusDateFrom
        schema:
          type: string
      - description: Filter by the record's status date range ending with this date.
        in: query
        name: statusDateTo
        schema:
          type: string
      - description: Record update Date From
        in: query
        name: updateDateFrom
        schema:
          type: string
      - description: Record update Date To
        in: query
        name: updateDateTo
        schema:
          type: string
      - description: Filter by the deparment which completed the application.
        in: query
        name: completedByDepartment
        schema:
          type: string
      - description: Filter by the user who completed the application.
        in: query
        name: completedByUser
        schema:
          type: string
      - description: Filter by the record's closed date range starting with this date.
        in: query
        name: closedDateFrom
        schema:
          type: string
      - description: Filter by the record's closed date range ending with this date.
        in: query
        name: closedDateTo
        schema:
          type: string
      - description: Filter by the department which closed the application.
        in: query
        name: closedByDepartment
        schema:
          type: string
      - description: Filter by the user who closed the application.
        in: query
        name: closedByUser
        schema:
          type: string
      - description: Filter by record class
        in: query
        name: recordClass
        schema:
          type: string
      - description: Filter by comma-separated multiple record types.
        in: query
        name: types
        schema:
          type: string
      - description: Filter by comma-separated multiple modules.
        in: query
        name: modules
        schema:
          type: string
      - description: Filter by comma-separated multiple record status types.
        in: query
        name: statusTypes
        schema:
          type: string
      - description: Comma-delimited list of related objects to be returned with the response. The related object(s) will be returned if data exists; if data does not exist, the requested object(s) will not be included in the response.
        in: query
        name: expand
        schema:
          type: string
          enum:
          - addresses
          - parcels
          - professionals
          - contacts
          - owners
          - customForms
          - customTables
      - name: expandCustomForms
        description: "Valid values: \"addresses\"\n          \nIf {expand} includes any of addresses, parcels, owners, or contacts, {expandCustomForms} specifies which {expand} objects should include custom forms. By default, custom forms for addresses, parcels, owners, and contacts are not included in the response data. Note that requesting APO custom forms may have performance implications, depending on the amount of data and connectivity to any external data source.\n\nAdded in Civic Platform version: 9.2.0\n"
        in: query
        schema:
          type: string
          enum:
          - addresses
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_recordExtModel_1Array'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{ids}:
    delete:
      tags:
      - Records
      summary: Delete Records
      description: 'Deletes the specified record.


        **API Endpoint**: DELETE /v4/records/{ids}


        **Scope**: records


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.3'
      operationId: v4.delete.records.ids
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - description: Comma-delimited IDs of the records to be deleted.
        in: path
        name: ids
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    get:
      tags:
      - Records
      summary: Get Records
      description: 'Gets the requested record(s).


        **API Endpoint**: GET /v4/records/{ids}


        **Scope**: records


        **App Type**: All


        **Authorization Type**: No authorization required


        **Civic Platform version**: 7.3.2'
      operationId: v4.get.records.ids
      parameters:
      - description: Comma-delimited IDs of the records to fetch.
        in: path
        name: ids
        required: true
        schema:
          type: string
      - description: Comma-delimited list of related objects to be returned with the response. The related object(s) will be returned if data exists; if data does not exist, the requested object(s) will not be included in the response.
        in: query
        name: expand
        schema:
          type: string
          enum:
          - addresses
          - parcels
          - professionals
          - contacts
          - owners
          - customForms
          - customTables
          - assets
      - name: expandCustomForms
        description: 'Valid values: "addresses"


          If {expand} includes any of addresses, parcels, owners, or contacts, {expandCustomForms} specifies which {expand} objects should include custom forms. By default, custom forms for addresses, parcels, owners, and contacts are not included in the response data. Note that requesting APO custom forms may have performance implications, depending on the amount of data and connectivity to any external data source.


          Added in Civic Platform version: 9.2.0

          '
        in: query
        schema:
          type: string
          enum:
          - addresses
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_recordModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{id}:
    put:
      tags:
      - Records
      summary: Update Record
      description: 'Updates details for the specified record.


        **API Endpoint**: PUT /v4/records/{id}


        **Scope**: records


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      operationId: v4.put.records.id
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - description: The ID of the record to update.
        in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/simpleRecordModel'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/request_simpleRecordModel'
        description: Record information to be updated.
        required: true
  /v4/records/{recordId}/additional:
    get:
      tags:
      - Records
      summary: Get Additional Details for Record
      description: 'Gets additional information for the requested record.


        **API Endpoint**: GET /v4/records/{recordId}/additional


        **Scope**: records


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      operationId: v4.get.records.recordId.additional
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - description: The ID of record to fetch.
        in: path
        name: recordId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_recordAdditionalModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    put:
      tags:
      - Records
      summary: Update Additional Details for Record
      description: 'Updates additional information for the specified record.


        **API Endpoint**: PUT /v4/records/{recordId}/additional


        **Scope**: records


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      operationId: v4.put.records.recordId.additional
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - description: The ID of the record to fetch.
        in: path
        name: recordId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_recordAdditionalModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/recordAdditionalModel'
        description: Additional record information for update.
        required: true
  /v4/records/{recordId}/finalize:
    post:
      description: 'Creates the finalized record in the database. Use this method after calling Create Partial Record to submit the completed record. See Creating Records for more information about calling Finalize Record in tandem with Create Partial Record.


        The Create Partial Record API triggers the business rules engine event ApplicationSubmitAfter.


        Note: The Finalize Record API does not include custom forms and custom tables in the request body. To add or update custom forms and custom tables, use the Update Record Custom Forms and Update Record Custom Tables between the Create Partial Record and Finalize Record requests.


        **API Endpoint**: POST /v4/records/{recordId}/finalize


        **Scope**: records


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      summary: Finalize Record
      operationId: v4.post.records.recordId.finalize
      tags:
      - Records
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - $ref: '#/components/parameters/recordId'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_simpleRecordModel'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/request_recordModel'
        description: Create Record request information.
        required: true
  /v4/records/{recordId}/related:
    get:
      description: 'Gets the records related, by a parent or child relation, to the specified record.


        **API Endpoint**: GET /v4/records/{recordId}/related


        **Scope**: records


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      summary: Get All Related Details for Record
      operationId: v4.get.records.recordId.related
      tags:
      - Records
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - $ref: '#/components/parameters/recordId'
      - description: Filter by record relationship.
        in: query
        name: relationship
        required: false
        schema:
          type: string
          enum:
          - parent
          - child
          - renewal
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_recordRelatedModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: 'Creates a child relationship to the specified (parent) record.


        **API Endpoint**: POST /v4/records/{recordId}/related


        **Scope**: records


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      summary: Create Related Details for Record
      operationId: v4.post.records.recordId.related
      tags:
      - Records
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - $ref: '#/components/parameters/recordId'
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
      requestBody:
        content:
          application/json:
            schema:
              items:
                type: string
              type: array
        description: Related record information to be added.
        required: true
  /v4/records/{recordId}/related/{childRecordIds}:
    delete:
      description: 'Removes the relationship between the specifed child record(s) and their specified parent record.


        **API Endpoint**: DELETE /v4/records/{recordId}/related/{childRecordIds}


        **Scope**: records


        **App Type**: Agency


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      summary: Delete Related Details from Record
      operationId: v4.delete.records.recordId.related.childRecordIds
      tags:
      - Records
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - $ref: '#/components/parameters/recordId'
      - description: Comma-delimited IDs of the related records to be removed.
        in: path
        name: childRecordIds
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          content:
            application/json:
              schema:
          

# --- truncated at 32 KB (165 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/accela/refs/heads/main/openapi/accela-records-api-openapi.yml