List all the users of a company

• Endpoint: /v1/users
• Description: Retrieves a list of all users within a company, including details such as usernames, roles, and contact information.
• Use Case: This is useful for administrators who need a complete view of all users in the system, helping them manage access, roles, and monitor user activity within the company.

Fetch a specific user using an ID

• Endpoint: v1/users/{id}
• Description: Fetches detailed information about a specific user by their unique user ID.
• Use Case: Used by Fleet Managers or Admins to view individual user profiles, verify user details, and check the roles or permissions assigned to a specific user.

Create a new user

• Endpoint: v1/users
• Description: Creates a new user profile within the company with specified details such as name, email, role, and permissions.
• Use Case: This endpoint is essential for adding new team members to the company system, assigning roles, and setting initial access permissions, which is critical for scaling operations or onboarding new hires.

Update an existing user

• Endpoint: v1/users/{id}
• Description: Updates the information for an existing user, such as changing their role, contact information, or info.
• Use Case: Useful for administrators when a user’s role changes, or when there is a need to correct or update their details, ensuring that user data remains accurate and up-to-date.

Search for a specific user

• Endpoint: v1/users?lookup
• Description: Allows searching for users within the company based on specific criteria, such as name, email, or Company ID.
• Use Case: This endpoint is helpful when administrators need to find a user without knowing their exact ID, speeding up user management tasks and simplifying the process of locating specific profiles.

Use external ID to search for a user

• Endpoint: v1/users/lookup_by_external_id
• Description: Retrieves user information based on an external ID, which may be used in third-party integrations or legacy systems.
• Use Case: Ideal for companies with integrated systems where users are referenced by an external ID, allowing quick and easy access to the corresponding user data in the Motive platform.

View the permissions of a user role

• Endpoint: v1/user_roles
• Description: Provides details on the permissions associated with each user role, including access levels and actions allowed.
• Use Case: Useful for administrators to understand and manage role-based access controls, ensuring users have appropriate permissions aligned with company policies and security protocols.