Users can log in to your Claimable account.
User objects represent a person who has access to your Claimable account and who can log in, modify data, perform activities based on their privilege level as defined by their role and company.
Users are often referred to by other objects, such as to indicate who is the creator or assignee of a given record.
The User Object
User Object| Attribute | Data Type | Description |
|---|---|---|
| id | Integer | The unique ID for the user given by Claimable. |
| first_name | String | The user's first or given name |
| last_name | String | The user's last or family name. |
| full_name | String | Read Only. Combination of first_name and last_name |
| display_name | String | Read Only. Abbreviated name consisting of first_name + first character of last_name. |
| String | The user's email address. Used to login to Claimable and for system notifications. | |
| status | String | Read Only. The current status of the user, which can either be "active", "inactive" or "invited". |
| role | String | A string representing the user's login role, which defines what level of access they have to your Claimable account. One of: "administrator", "manager", "claim_handler", "contributor" & "claim_creator". |
| created_claims_count | Object | Read Only. Shows the number of claims created by this user, split into open and closed claims. |
| last_active_at | Timestamp | Read Only. A timestamp showing when the user was last active on Claimable. |
{
"id": 1234,
"first_name": "Eric",
"last_name": "Cartman",
"full_name": "Eric Cartman",
"display_name": "Eric C.",
"email": "[email protected]",
"claimable_mailbox_address": "[email protected]",
"status": "active",
"role": "manager",
"external": false,
"company_name": "Claimable",
"mfa_enabled": false,
"mfa_enabled_methods": [],
"avatar_color": "#bbb2d2",
"avatar_initials": "EC",
"avatar_svg": "<svg height=\"26\" width=\"26\"> <rect fill=\"#bbb2d2\" x=\"0\" y=\"0\" width=\"26\" height=\"26\" rx=\"1\"></rect> <text font-family=\"Helvetica-Bold, Helvetica\" x=\"14\" y=\"17\" font-size=\"11\" font-weight=\"bold\" letter-spacing=\"1\" fill=\"#3c3353\" text-anchor=\"middle\" alignment-baseline=\"central\">EC</text> </svg>",
"created_claims_count": {
"total": 0,
"open": 0,
"closed": 0
},
"assigned_claims_count": {
"total": 363,
"open": 20,
"closed": 0
},
"created_tasks_count": {
"total": 846,
"open": 844,
"closed": 2
},
"assigned_tasks_count": {
"total": 1402,
"open": 1262,
"closed": 140
},
"last_active_at": "2023-02-27T17:23:51.329Z"
}