Description: This document provides an overview of the data you can access through the Hamlet API's /users endpoint.

What You Can Access

Using the Hamlet API, you can retrieve various details about users. Here are the key pieces of information you can access:

1. User Information
   • User Profile ID
   • Name
   • First Name
   • Last Name
   • Email
   • Mobile Number
   • Status (e.g., ACTIVE, INACTIVE)
   • Join Date
   • Title
   • Type
   • Timezone
   • Image
   • Created At (Date and Time)
   • Updated At (Date and Time)
   • Active Status
2. Company Information
   • Company ID
   • Company Name
3. Location Information
   • Location ID
   • Location Name
4. Additional Details
   • Level Name

How to Use

To access this data, you will need to make a request to the Hamlet API's /users endpoint. You can filter the data based on various criteria such as user profile ID, name, email, mobile number, company ID, location ID, and more.

Example Use Cases

• Retrieve Users by Status: Get a list of users based on their current status (e.g., ACTIVE, INACTIVE).
• Filter by Company: Find users associated with a specific company.
• Sort Users: Sort the users by creation date or name.

Rate Limits

• You can make up to 60 requests per minute.
• Each request can return a maximum of 100 records.

More about API

1. Accessing Invoices Data via Hamlet API