API Changelog
Back to All
added

New Users Endpoints

over 1 year ago by David Lawrence

We've just added /users and /users/:id endpoints to our API allowing you to fetch various metadata about the users on your Claimable account, for reporting or monitoring purposes.

Another useful benefit is to identify users referred by attributes on other records. On various endpoints the objects returned often contain a reference to a user ID, such as to identify who created or updated a record. You can now make a GET request to /users/:id to retrieve not only the user's name, email address, role and company, but other useful metadata such as:

  • status - the current status of the user, which can either be "active", "inactive" or "invited".
  • last_active_at - a timestamp showing when the user was last active on Claimable.
  • claimable_mailbox_address - the user's unique Claimable email address from which Claimable-generated email is sent and to which any replies are received.
  • mfa_enabled - indicates if the user has Multi-Factor Authentication enabled on their account.
  • created_claims_count - shows the number of claims created by this user, split into open and closed claims.
  • assigned_claims_count - shows the number of claims assigned to this user, split into open and closed claims.
  • created_tasks_count - shows the number of tasks created by this user, split into open and closed tasks.
  • assigned_tasks_count - shows the number of tasks assigned to this user, split into open and closed tasks.

The list users endpoint also supports scoping and searching. You can use the s query param to search by name & email address and the scope query param lets you filter users by:

  • active - all users with the status "active".
  • inactive - all users with the status "inactive".
  • invited - all invited users, with a currently pending invite awaiting acceptance.
  • mfa_enabled - all users with at least one Multi-Factor Authentication method enabled.
  • mfa_disabled - all users without any Multi-Factor Authentication method enabled.

You can read more about the new Users endpoints on the API Reference pages below:

Users