API reference / Admin

get/v2/projects/{id}/users

List a tenant’s portal users

Operation
listPartnerUsers
Authentication
API key

Internal. Requires `projects:write`.

Request

Parameters

idpathrequiredstring

Responses

200Partner staff for this tenant.
usersPartnerUser[]required
400The request body or query failed validation.
errorobjectrequired
401No key, an unknown key, a revoked key, or a key whose tenant is not active. All four return an identical body on purpose: distinguishing them would let a caller discover which partners we have.
errorobjectrequired
403`projects:write` is required. No partner key is ever issued this scope.
errorobjectrequired
404Not found, or not yours. A resource belonging to another tenant answers 404 rather than 403, because 403 would confirm the record exists.
errorobjectrequired

Example

curl
curl -X GET https://api.haavisa.com/v2/projects/<id>/users \
  -H "Authorization: Bearer $HAAVISA_API_KEY"

More in Admin

Something unclear? The eligibility guide explains the model behind the answers; the errors guide covers the envelope.