get
https://api.genability.com/rest/v1/accounts//properties
Return a single account using the Arcadia {accountId} value.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Retrieve all properties associated with an account using the Arcadia-generated accountId.
Use this endpoint to inspect account-specific values used by calculations and tariff applicability checks, such as customerClass, building attributes, location details, and tariff-specific options.
Resource URI
GET /rest/v1/accounts/{accountId}/propertiesPath parameters
| Parameter | Type | Description |
|---|---|---|
accountId | String | Arcadia UUID of the Account object. Required. |
Response data
The response returns PropertyData objects. Common fields include:
| Field | Description |
|---|---|
keyName | Unique property key, such as customerClass. |
displayName | User-friendly property label. |
description | Description of what the property represents. |
dataType | Data type, such as CHOICE, BOOLEAN, INTEGER, or DECIMAL. |
choices | Possible values for CHOICE or LOOKUP properties. |
dataValue | Value stored on the account. |
For the full account property data model, account property workflow, and detailed examples, see Account Properties API.
Example
GET /rest/v1/accounts/9a6035d8-94cd-4d66-8a94-eac573fec42e/propertiesA successful response returns a standard response payload with type set to PropertyData and results containing the account's properties.
{
"status": "success",
"count": 1,
"type": "PropertyData",
"results": [
{
"keyName": "customerClass",
"displayName": "Customer Class",
"dataType": "CHOICE",
"dataValue": "1"
}
]
}