Skip to main content
GET
List users

Authorizations

Authorization
string
header
required

An API key of the form mya_…, sent as Authorization: Bearer mya_…. The secret is shown once, when the key is created.

Query Parameters

id
string[]
Maximum array length: 100
Minimum string length: 1
brokerage
string[]
Maximum array length: 100
Minimum string length: 1
status
enum<string>

Membership status. New values may be added; this is not a breaking change. Handle unknown values.

Available options:
active,
inactive
office
string
Minimum string length: 1
role
enum<string>[]
Maximum array length: 100

Role. New values may be added; this is not a breaking change. Handle unknown values.

Available options:
system_admin,
org_admin,
brokerage_admin,
office_admin,
team_leader,
deal_processor,
closing_processor,
listing_processor,
deal_processor_manager,
agent,
assistant
cursor
string

Opaque: send back a next_cursor unchanged.

Minimum string length: 1
limit
integer
default:50
Required range: 1 <= x <= 100

Response

OK

Users in id order. A reference set: re-list it; there is no updated_since.

object
any
required
data
object[]
required
has_more
boolean
required
next_cursor
string | null
required