Skip to content
API status
API reference

List account credentials

GET
/api/v1/management/servers/{serverId}/account-credentials
curl --request GET \
--url 'https://api.koneth.com/api/v1/management/servers/6be9a699-2f28-402e-b64e-93ba6bdafe1b/account-credentials?offset=0&limit=500' \
--header 'Authorization: <Authorization>' \
--header 'X-Request-Id: onboarding-client-1042'

Returns the stored trading and investor password of every account on a server, oldest account first. Requires accounts:read. This is the only Management API operation that returns account passwords, so treat the response as a secret: do not log it, keep it out of client-side code, and prefer resetting a password over re-reading it. Page with offset until nextOffset is null.

serverId
required
string format: uuid

UUID of a trading server owned by your organization.

Example
6be9a699-2f28-402e-b64e-93ba6bdafe1b
X-Request-Id
string

Optional correlation ID used for API request billing and logs.

Example
onboarding-client-1042
offset
integer
0

Number of accounts to skip.

limit
integer
default: 500 >= 1 <= 500

Maximum number of accounts to return.

Account credentials returned.

Media typeapplication/json
object
accounts
required
Array<object>
object
managedAccountId
required
string format: uuid
accountNumber
required
string
accountName
required
string
status
required

Account status in Koneth Main, such as active, pending, or failed.

string
tradingPassword
required

Decrypted trading password, or null when none is stored.

string
nullable
investorPassword
required

Decrypted investor password, or null when none is stored.

string
nullable
nextOffset
required

Offset to request next, or null when this is the last page.

integer
nullable
Example
{
"accounts": [
{
"status": "active"
}
]
}

Invalid request.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Examplegenerated
{
"error": "example",
"issues": [
{}
]
}

Management API authentication is missing or invalid.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Example
{
"error": "Management API authentication required"
}

The organization cannot cover the active API request price.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Example
{
"error": "Insufficient API credits"
}

The key lacks the required scope or server access.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Example
{
"error": "Missing API scope: accounts:read"
}

Unexpected server error.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Example
{
"error": "Internal server error"
}