Skip to content

Get an end-user

GET https://rest.haasapi.com/v1/partner/users/{user_id}

Returns one white-label end-user this partner manages - the same curated row GET /v1/partner/users lists. An unknown or foreign user_id answers 404: the id is scoped to the authenticated partner, so ids stay non-enumerable across partners.

Requires the partner scope.

Terminal window
curl "https://rest.haasapi.com/v1/partner/users/{user_id}" \
-H "Authorization: Bearer hk_live_YOUR_KEY"

200 OK. Returns a PartnerUser.

{
"user_id": "8f14e45f-ceea-467a-9c9a-2b0f1d6a3c77",
"exchange": "BINANCE",
"external_id": "customer-4471",
"created_at": "2026-08-28T19:04:11Z",
"bots_started": 12,
"bots_active": 3,
"backtests": 40
}
Field Type Description
user_id string The end-user identifier - the id every /v1/partner/users/{user_id} path takes. Copy it from this endpoint; never construct one.
exchange string Exchange code the end-user’s account trades on.
external_id string, nullable Your own reference for this end-user, if you set one when provisioning it. null otherwise.
created_at string When the end-user was provisioned. RFC 3339 UTC.
bots_started integer (int32) Total bots ever started for this end-user.
bots_active integer (int32) Bots currently running for this end-user.
backtests integer (int32) Total backtests run for this end-user.

All errors are RFC 9457 problem documents.

Status Description
400 The request is malformed (invalid limit, unusable cursor, …). (code: invalid_request)
401 Missing, malformed, disabled, or revoked API key. (code: invalid_api_key)
404 No accessible end-user with that id. (code: user_not_found)
500 An unexpected error inside the API. Nothing about the request caused it; retry, and quote the instance value if it persists. (code: internal_error)
502 An internal service answered in a way the API could not serve. Retry. (code: upstream_error)
503 The request could not be served right now. Retry with the same key - do not discard it. (code: temporarily_unavailable)
504 An internal service did not answer within the deadline. Retry with backoff. (code: upstream_timeout)
{
"type": "https://docs.haasapi.com/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"detail": "The request is malformed (invalid limit, unusable cursor, …).",
"code": "invalid_request"
}