RetailHardHat Developer docs

REST API documentation

Users

User accounts (read-only via API)

Supported operations

MethodPathDescription
GET/api/v1/usersList all users in tenant
GET/api/v1/users/:idGet a user by ID

Example request

Replace YOUR_API_KEY with a private key stored in your environment. Replace path parameters with records from your organization.

curl --request GET "/api/v1/users" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json"

Field reference

Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.

FieldTypeModel requirementDescription
idstringOptionalUnique identifier (auto-generated)
displayNamestringRequiredusername
emailstringRequiredemail
roleenumOptionalrole

Values: owner, admin, member

defaultTeamenumOptionaldefault Team

Values: construction, real_estate, finance, operations, legal, marketing, hr, it, general

createdAtdatetimeOptionalCreation timestamp (auto)