Accela

Accela Settings/Addresses API

The Settings/Addresses API from Accela — 7 operation(s) for settings/addresses.

GitHub OpenAPI

Operations 7

GET /v4/settings/addresses/countries Get All Address Countries #
GET /v4/settings/addresses/customForms Get Metadata for Address Custom Forms #
GET /v4/settings/addresses/states Get All Address States #
GET /v4/settings/addresses/streetDirections Get All Address Street Directions #
GET /v4/settings/addresses/streetFractions Get All Address Street Fractions #
GET /v4/settings/addresses/streetSuffixes Get All Address Street Suffixes #
GET /v4/settings/addresses/unitTypes Get All Address Unit Types #

Documentation

📖
Documentation
https://developer.accela.com/docs/
📖
APIReference
https://developer.accela.com/docs/api_reference/api-index.html
📖
Documentation
https://developer.accela.com/docs/construct-apiAuth.html
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/accela/refs/heads/main/authentication/accela-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/accela/refs/heads/main/openapi/accela-settings-addresses-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/accela/refs/heads/main/conventions/accela-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/accela/refs/heads/main/errors/accela-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/accela/refs/heads/main/data-model/accela-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/accela/refs/heads/main/scopes/accela-scopes.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/accela-settings-addresses-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

accela-settings-addresses-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: The Settings API provides configuration values that have been defined in Civic Platform Administration, typically as standard choice values. The Settings APIs are helpful when you need reference or custom-configured values in your API calls.
  title: Settings/Addresses API
  version: v4
servers:
- url: https://apis.accela.com/
tags:
- name: Settings/Addresses
paths:
  /v4/settings/addresses/countries:
    get:
      description: 'Gets the countries for use in an address.


        **API Endpoint**: GET /v4/settings/addresses/countries


        **Scope**: addresses


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      summary: Get All Address Countries
      operationId: v4.get.settings.addresses.countries
      tags:
      - Settings/Addresses
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/addresses/customForms:
    get:
      summary: Get Metadata for Address Custom Forms
      description: 'Returns the field metadata for all address custom forms (address templates) in the system.


        **API Endpoint**: GET /v4/settings/addresses/customForms


        **Scope**: addresses


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 9.3.0'
      tags:
      - Settings/Addresses
      operationId: v4.get.settings.addresses.customForms
      parameters:
      - description: Construct oAuth2 authentication token
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: Language parameter to support I18N. Default language is en_US
        in: query
        name: lang
        required: false
        schema:
          type: string
      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_apo_customForms_metadata'
        '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/settings/addresses/states:
    get:
      description: 'Gets the states for use in an address.


        **API Endpoint**: /v4/settings/addresses/states GET


        **Scope**: addresses


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      summary: Get All Address States
      operationId: v4.get.settings.addresses.states
      tags:
      - Settings/Addresses
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/addresses/streetDirections:
    get:
      description: 'Gets the street directions for use in an address.


        **API Endpoint**: GET /v4/settings/addresses/streetDirections


        **Scope**: addresses


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      summary: Get All Address Street Directions
      operationId: v4.get.settings.addresses.streetDirections
      tags:
      - Settings/Addresses
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/addresses/streetFractions:
    get:
      description: 'Gets the street fractions for use in an address.


        **API Endpoint**: GET /v4/settings/addresses/streetFractions


        **Scope**: addresses


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      summary: Get All Address Street Fractions
      operationId: v4.get.settings.addresses.streetFractions
      tags:
      - Settings/Addresses
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/addresses/streetSuffixes:
    get:
      description: 'Gets the street types for use in an address.


        **API Endpoint**: GET /v4/settings/addresses/streetSuffixes


        **Scope**: addresses


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      summary: Get All Address Street Suffixes
      operationId: v4.get.settings.addresses.streetSuffixes
      tags:
      - Settings/Addresses
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/addresses/unitTypes:
    get:
      description: 'Gets the unit types for use in an address.


        **API Endpoint**: GET /v4/settings/addresses/unitTypes


        **Scope**: addresses


        **App Type**: All


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      summary: Get All Address Unit Types
      operationId: v4.get.settings.addresses.unitTypes
      tags:
      - Settings/Addresses
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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.
components:
  schemas:
    apo_customForms_metadata:
      description: 'Contains metadata description of a custom form, including the custom fields metadata. '
      type: object
      properties:
        name:
          type: string
          description: The name of the custom form
        description:
          type: string
          description: Describes the usage or puporse of the custom form.
        fields:
          items:
            $ref: '#/components/schemas/apo_customForms_metadata_fields'
          type: array
          description: Contains the field metadata.
        id:
          type: string
          description: The unique string identifier of the custom form.
        customFormType:
          type: string
          description: Indicates whether the custom form is for an address, parcel, or owner.
    settingValueModelAddressTypes:
      type: object
      properties:
        text:
          description: The setting label.
          type: string
        value:
          description: The setting value.
          type: string
        required:
          description: Indicates whether or not it is required for an address type.
          type: boolean
    settingValueModel:
      type: object
      properties:
        text:
          description: The setting label.
          type: string
        value:
          description: The setting value.
          type: string
        addressTypes:
          items:
            $ref: '#/components/schemas/settingValueModelAddressTypes'
          type: array
    response_settingValueModelArray:
      type: object
      properties:
        result:
          description: Contains the settings.
          items:
            $ref: '#/components/schemas/settingValueModel'
          type: array
        status:
          type: integer
          description: The HTTP return status.
    response_apo_customForms_metadata:
      type: object
      properties:
        result:
          items:
            $ref: '#/components/schemas/apo_customForms_metadata'
          type: array
        status:
          type: integer
          description: The return status code.
    apo_customForms_metadata_fields:
      description: "Describes the metadata of a custom field. \n\nAdded in Civic Platform version: 9.2.0"
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: The unique custom field id.
        name:
          type: string
          description: The field name.
        description:
          type: string
          description: Describes the usage or purpose of the custom field.
        label:
          type: object
          description: The field label.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        dataType:
          type: string
          enum:
          - Number
          - Text
          - Date
          - Radio
          - DropdownList
          description: The field data type. If the custom field is a DropdownList, the options[] array contains the list of possible values, or the sharedDropdownListName specifies the name of a shared dropdown list containing the possible values.
        defaultValue:
          type: string
          description: Any default value for the custom field.
        displayOrder:
          format: int64
          type: integer
          description: The display order of the field on the custom form.
        unit:
          type: string
          description: The unit of measure of a numeric custom field.
        isRequired:
          type: string
          enum:
          - Y
          - N
          description: Indicates whether or not the field is required.
        isPublicVisible:
          type: string
          enum:
          - Y
          - N
          description: Indicates whether or not a citizen user can see this field.
        isRecordSearchable:
          type: string
          enum:
          - Y
          - N
          description: Indicates whether or not the field is searchable.
        maxLength:
          format: int64
          type: integer
          description: The field maximum length.
        options:
          items:
            type: object
            description: A dropdown field value.
            properties:
              text:
                description: The localized display value.
                type: string
              value:
                description: The data value.
                type: string
          type: array
          description: Contains possible field values, if the field is a dropdown field type.
        sharedDropdownListName:
          type: string
          description: The name of the shared dropdown list, if the field is a dropdown field type.
  parameters:
    lang:
      description: Language parameter to support I18N. Default language is en_US.
      in: query
      name: lang
      required: false
      schema:
        type: string
    authHeaderParam:
      description: Construct oAuth2 authentication token
      in: header
      name: Authorization
      required: true
      schema:
        type: string
x-api-evangelist-provenance:
  generated: '2026-09-06'
  method: searched
  source: https://developer.accela.com/api/v4/v4-settings.json
  note: Harvested verbatim from the Accela Developer Portal API Reference, which renders these Swagger 2.0 documents via ReDoc (spec-url on developer.accela.com/docs/api_reference/api-*.html). The byte-identical original is kept at openapi/_original/. This copy is the same document serialized to YAML.