API Reference
  1. Viv Public API
  2. Users

List users (staff members)

get
https://{apiHost}/api/v2/public/users

Get all admin users (staff members) who can be assigned to leads, manage clients, etc.
Use this endpoint to find valid user IDs for fields like managedBy on leads.

Required scope: users:read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Search by name (full name, first name, last name) or email (case-insensitive partial match)

string
enum

Filter by role

Allowed:
string
enum

Filter by status. Defaults to 'signedup' (active users).

Allowed:
string

Filter by primary geo ID

integer
≤ 100
Defaults to 50

Maximum results to return (max 100)

integer
Defaults to 0

Pagination offset

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?