Users / Search
Long Description
Search endpoint that will allow you to search across all of your brokerage's users.
Parameters
Name | Description | Value Type | Required |
|---|---|---|---|
| q | Search params | String | Required |
| page | Number of pages that you want to return | Integer | Optional |
| per_page | Number of results returned per page | Integer | Optional |
Examples
| Request | Response |
|---|---|
| /v9/users/search | |
Paste in Request Code | {
"users" => [
[0] {
"email" => "dgainor@ticketevolution.com",
"_type" => "User",
"updated_at" => nil,
"phone" => {
"number" => "201-499-0833",
"extension" => "101"
},
"name" => "Drew Gainor",
"office" => {
"name" => "Jersey City",
"brokerage" => {
"abbreviation" => "Ticket Evolution",
"name" => "Ticket Evolution",
"id" => "61",
"url" => "/brokerages/61"
},
"url" => "/offices/6",
"id" => "6"
},
"_score" => 1.0,
"url" => "/users/458",
"id" => "458"
}
]
}
|