Backoffice

Get User By Email Route

Changed on

Get User

get/backoffice/users/by/email/{email}

Request

  • Base URL
    https://api.toolhouse.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.toolhouse.ai/backoffice/users/by/email/{email}
  • Auth
    HTTP bearer

Path parameters

emailstring required

Response

User retrieved successfully

idstring required
auth_idstring required
emailstring required
read_onlyboolean
languagestring nullable
credit_multiplierinteger
organisation_limitinteger
created_atstring date-time nullable
is_organisation_memberboolean
can_use_organisationsboolean required

Whether the organisation switcher should be shown to this user.

True either because they may create organisations of their own, or because they have been invited into someone else's — with a limit of 0 and no memberships the personal organisation is all they will ever have, so there is nothing to switch between.

Changes

  • 9dc55a5522bbRevision changes
    • info

      added the optional property / to the response with the status

  • 72e064594fc8Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status