v1

latestSwagger 2.02026-08-04244186228.2 KB
authentication

Create a new user

post/v1/users

Headers

X-Fieldsstring mask

An optional fields mask

Request body

emailstring
metadataobject
activeboolean

Response

Success

emailstring
metadataobject
activeboolean
idstring

The user instance unique identifier

createdstring

time the user was created

apiKeystring
companystring
sysAdminboolean
groupsstring[]
plan'FREEMIUM' | 'FULL'
usernamestring
backofficeAdminboolean
trialDaysinteger

Example response

{
  "plan": "FREEMIUM",
  "organizationMemberships": [
    {
      "status": "INVITED",
      "role": "MEMBER"
    }
  ]
}