GET
Read many User
Get a list of your users.
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
(optional)
integer
Take N records. Default value is 10. Max value is 100.
(optional)
integer
Skip N records.
(optional)
string
Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering.
Request headers
string
Subscription key which provides access to this API.
Response 200
Returns a simplified list of users for your query.
- 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.
-
integer
user_role: A number to identify role of user. Possible values are:
- 0: Firm user.
- 2: Legal entity user.
- 4: Agent user.
- 8: Admin user (internal).
- 16: System user (internal).
- 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": "array",
"items": {
"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": "integer"
},
"last_login_date": {
"type": "string"
},
"is_locked_out": {
"type": "boolean"
},
"user_type_id": {},
"user_type_name": {}
},
"required": [
"id",
"first_name",
"last_name",
"user_name",
"email",
"phone_number",
"language_id",
"language_name",
"country_id",
"country_name",
"user_role",
"last_login_date",
"is_locked_out",
"user_type_id",
"user_type_name"
]
}
}