get
https://api.genability.com/rest/v1/accounts
Query all your organization's accounts or ones that match criteria supplied in the available query parameters.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Retrieve accounts for your organization, optionally filtered by search criteria.
Use this endpoint to list accounts, build account search experiences, or find accounts before retrieving related profiles, tariffs, properties, rates, calculations, or analyses. To retrieve a known account directly, use Get One Account with accountId or Get One Account with providerAccountId.
Resource URI
GET /rest/v1/accountsQuery parameters
| Parameter | Type | Description |
|---|---|---|
search | String | Text to search for. Can be a regular expression when isRegex=true. Optional. |
searchOn | String | Account fields to search. If search is specified without searchOn, defaults to accountName and customerOrgName. Optional. |
startsWith | Boolean | When true, returns results that begin with the search string. Defaults to false. Optional. |
endsWith | Boolean | When true, returns results that end with the search string. Defaults to false. Optional. |
isRegex | Boolean | When true, treats search as a regular expression. Defaults to false. Optional. |
pageStart | Integer | Index of the first result to return. Defaults to 0. Optional. |
pageCount | Integer | Number of results to return. Defaults to 25. Optional. |
sortOn | String | Comma-separated list of fields to sort on. Optional. |
sortOrder | String | Comma-separated sort order values, such as ASC or DESC. Defaults to ASC. Optional. |
fields | String | Pass ext to include extended fields in the response. Optional. |
For the full account data model, account workflow, and detailed examples, see Accounts API.
Example
GET /rest/v1/accounts?search=Peets&pageStart=0&pageCount=25A successful response returns a standard response payload with type set to Account and results containing matching accounts.
{
"status": "success",
"count": 1,
"type": "Account",
"results": [
{
"accountId": "jke34kjlsd998er",
"providerAccountId": null,
"accountName": "Peets Briarwood Mall",
"status": "ACTIVE"
}
]
}