Skip to main content
The Users API provides full lifecycle management of user accounts within the HoopAI Platform. Use it to create users and assign them to locations, retrieve users by location or search query, filter users by email address, update user profiles and role permissions, and delete users from the platform. It is designed for sub-account onboarding flows, team management integrations, and permission-controlled access provisioning across locations.

​
Base URL

https://services.leadconnectorhq.com

​
Authentication

All endpoints require a Bearer token and an API version header. 
Authorization: Bearer <access_token>
Version: 2021-07-28
See OAuth 2.0 to obtain an access token.

​
OAuth scopes

ScopeAccess
users.readonlyRead user profiles, roles, and location assignments
users.writeCreate, update, and delete users

​
Quick start

Create a new user and assign them to a location: 
curl -X POST https://services.leadconnectorhq.com/users/ \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28" \
  -H "Content-Type: application/json" \
  -d '{
    "companyId": "company_abc123",
    "firstName": "Alex",
    "lastName": "Smith",
    "email": "alex.smith@example.com",
    "phone": "+14155552671",
    "type": "account",
    "role": "user",
    "locationIds": ["location_xyz456"],
    "password": "SecurePass123!"
  }'

​
Endpoints

MethodPathDescription
GET/users/Get user by location
POST/users/Create user
GET/users/{userId}Get user
PUT/users/{userId}Update user
DELETE/users/{userId}Delete user
GET/users/searchSearch users
POST/users/search/filter-by-emailFilter users by email
  • Locations API — Manage the locations that users are assigned to
  • Calendars API — Assign availability schedules and calendars to users
  • OAuth API — Configure scopes and access tokens for user-level authentication
Last modified on March 4, 2026