Users

List Users

Retrieve a paginated list of workspace team members. Use this endpoint to resolve user names to IDs for assignment operations (e.g., assigning a job or event to a specific team member).

GET /api/v1/users

Required Scope: users:read

Query Parameters:

Parameter	Type	Default	Description
`page`	integer	`1`	Page number
`per_page`	integer	`25`	Results per page (1-100)
`search`	string		Search by name, email, or phone
`sort_by`	string		Field to sort by. Valid: `first_name`, `last_name`, `email`, `role`, `job_title`, `created_at`, `updated_at`. `name` is accepted as an alias for `first_name`.
`sort_direction`	string	`desc`	Sort direction (`asc` or `desc`)

curl https://app.bluesuite.com/api/v1/users?search=bob \
  -H "Authorization: Bearer wk_YOUR_API_KEY"

{
  "success": true,
  "data": [
    {
      "id": 12,
      "user_id": "684ac879-1234-5678-abcd-ef1234567890",
      "first_name": "Bob",
      "last_name": "Smith",
      "email": "bob@example.com",
      "role": "member",
      "job_title": "Field Technician"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total_pages": 1
  }
}

Response Fields:

Field	Type	Description
`id`	integer	User-workspace record ID
`user_id`	string (UUID)	User UUID — use this for `salesperson_id` and `assignee_ids` fields
`first_name`	string	First name
`last_name`	string	Last name
`email`	string	Email address
`role`	string	Workspace role (e.g., `owner`, `admin`, `member`)
`job_title`	string	Job title

List Users

On this page