Skip to main content
GET
LIST Account

Filters

Filters combine with AND: a result must match every filter you supply.

Authorizations

X-API-Key
string
header
required

Prophia API key — either an account key (grants admin level permissions) or a user key with the REST scope. Send it in the X-API-Key header, or equivalently as Authorization: Bearer <api-key>. JWTs are rejected on /rest endpoints with 401.

Query Parameters

include
enum<string>[]

Optional collections to populate. Unknown keys are rejected with 400.

  • properties — adds the flat list of properties on this account.
    • Requires the READ:PROPERTY capability.
Available options:
properties
page
integer<int32>
default:0

0-based page index. Negative values are clamped to 0.

limit
integer<int32>
default:50

Page size. Values outside 1–200 are clamped, not rejected; check the response's limit for the value actually applied.

sortBy
enum<string>
default:accountName

Sort field. Defaults to accountName; unrecognized values silently fall back to the default.

Available options:
accountName,
apiName,
accountStatus,
accountManager,
createdAt
sortDir
string
default:asc

Sort direction: asc (default) or desc. Any other value is treated as asc.

Filter
accountName
string

Case-insensitive contains match on the account name.

Filter
accountStatus
enum<string>

Filter by account status. Matching is case-insensitive; an unrecognized value returns no results.

Available options:
LIVE,
CHURN,
DEMO,
TEST,
CONTRACTOR,
AI,
INACTIVE
Filter
apiName
string

Case-insensitive contains match on the account's API name.

Filter
accountManager
string

Case-insensitive contains match on the account manager's name.

Response

OK

totalCount
integer<int64>

Total number of items matching the request across all pages.

page
integer<int32>

0-based index of this page.

limit
integer<int32>

Page size actually applied — requested values outside 1–200 are clamped.

items
object[]

The Accounts on this page of results.

hasMore
boolean

True when more pages exist after this one. Iterate on this rather than computing page counts from totalCount, which can change between requests.