Skip to content

User Schemas

User

Properties

PropertyTypeDescription
statusstring
user_idinteger
first_namestring
last_namestring
emailstring

UserCreateRequest

Properties

PropertyTypeDescription
emailstring
first_namestring
last_namestring
passwordstring
agency_namestring
websitestring
phonestring
addressstring
make_api_tokenintegerSet to 1 to also create an API token for the new user

UserCreateResponse

Properties

PropertyTypeDescription
statusstring
user_idinteger
access_tokenstringOnly returned if make_api_token=1

ApiAccessRequest

Properties

PropertyTypeDescription
user_idintegerUser ID to create API access for

ApiAccessResponse

Properties

PropertyTypeDescription
statusstring
access_tokenstring