HTTP Headers

Accela API supports these HTTP headers in requests.

Key Value Description
Content-Type {content-type}

Specify the content type in HTTP body for the current request.

Replace "{content-type}" with the actual content type value. The value is “application/json” by default.
Note: The POST /oauth2/token authentication API requires that the content-type header

is set to "application/x-www-form-urlencoded".
Accept {accept}

Specify the content type in HTTP body for the current response.

Replace "{accept}" with the actual Accept value. The value is “application/json” by default.
Authorization {access token}

Specify the authentication access token for the current request.

Replace "{access token}" with the actual access token value.

For more information, please refer to Logging in the Authentication Server.

x-accela-appid {app id}

Specify the app id for the current request.

Replace "{app id}" with the actual app id value.

To get an app id, create a new app in My App, and then copy the generated app id value.
x-accela-appsecret {app secret}

Specify the app secret for the current request.

Replace "{app secret}" with the actual app secret value.

To get an app secret, create a new app in My App, and then copy the generated app secret value.
x-accela-environment {environment name}

Specify the environment for the current request. Contact the agency administrator to get the environment supported by that agency.

Replace {environment name} with the actual environment value.

If you are providing both x-accela-environment and Authorization headers, the environment value embedded in the access token must match the x-accela-environment value.
x-accela-agency {agency name}

Specify the agency name for the current request.

Replace {agency name} with the actual agency name value.

For some citizen apps, you can get agency name dynamically by use the Search Agencies API by coordinates.

For more information about the agency name, contact your agency administrator.

If you are providing both x-accela-agency and Authorization headers, the agency value embedded in the access token must match the x-accela-agency value.
x-accela-agencies {all or agency1,agency2,agencyN}

Specify "all" or a comma-delimited list of agency names for the current request.

Use the x-accela-agencies HTTP Header to get an aggregated view of records across agencies for the accounts linked to the logged-in CivicID. This HTTP header applies to all Construct HTTP GET API's.

If the accounts linked to the logged-in CivicID do not have access to a specified agency, records from that agency will not be returned.

If x-accela-agency is also used, x-accela-agencies overrides x-accela-agency.

Limitations:

  • The same request API with the same parameters will be sent to all agencies, regardless of how the different agencies have customized their Automation configurations. For example, if a record type in Agency A is defined as "Permit/SingleFamilyHouse/Roof/Final" but defined as "Building/Residential/SingleFamily/RoofFinal" in Agency B, the API will simply return what was defined in each agency, regardless of configuration inconsistency.

  • An HTTP GET API that downloads objects (such as Download Document) is not supported.
Note: An Accela API resource requires a certain authentication type, which requires specific HTTP request headers. See API Authentication Types for the required HTTP request headers for each authentication type.

Accela API supports these HTTP headers in response.

Key Value Description
x-accela-traceId {trace id}

Indicates the trace id for HTTP response. The id is used for diagnostics purposes. Each response contains a unique trace id.
x-accela-resp-message {response message}

Indicates the response error message when there are any errors occurred.

You can see the response message in response body as well.
x-ratelimit-limit {allowed calls per hour} The maximum number of API calls permitted to make per hour.
x-ratelimit-remaining {remaining calls} The number of requests remaining in the current rate limit window.
x-ratelimit-reset {reset time} The time at which the current rate limit window resets in UTC epoch seconds.