GET

Read User

Get details about a specific User.

Important

Calls to this method must include the cookie .LawPanel.AuthCookie in order to identify you at user level. For more details about authentication please check this link. To obtain the cookie you can use the method Login.

Request URL

Request parameters

string

The user ID

Request headers

string

User authentication cookie. Read more about how to you get it from here.

string
Subscription key which provides access to this API.

Response 200

Returns details about the user.

  • string id: The ID for the user.
  • string first_name: Person first name.
  • string last_name: Person last name.
  • string user_name: Person user name. Use this value to login into your account.
  • string phone_number: Person phone number.
  • string language_id: Language ID for the user. You can get more details about the language here.
  • string language_name: Language human-readable name.
  • string country_id: Country ID for the user. You can get more details about the country here.
  • string country_name: Country human-readable name.
  • string user_role: A string with current role of user. Possible values are:

    • FirmUser.
    • ClientUser.
    • AgentUser.
    • AdminUser.
    • SystemUser.
  • string last_login_date: User last login date in ISO-8601 (UTC) format.
  • bool is_locked_out: If true the user can't login due to security reasons. Other user can revert this situation with an update.
  • string user_type_id: User type ID for the user. You can get more details about the user type here.
  • string user_type_name: User type human-readable name.

Loading... 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "user_name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "phone_number": {
      "type": "string"
    },
    "language_id": {
      "type": "string"
    },
    "language_name": {
      "type": "string"
    },
    "country_id": {
      "type": "string"
    },
    "country_name": {
      "type": "string"
    },
    "user_role": {
      "type": "string"
    },
    "last_login_date": {
      "type": "string"
    },
    "is_locked_out": {
      "type": "boolean"
    },
    "user_type_id": {
      "type": "string"
    },
    "user_type_name": {
      "type": "string"
    }
  }
}
* See getting started for more information on how to use this API. You can also check the API change history.