Users / List

Name	Index
Description	Return all users for a brokerage
Type	GET
URL	/v9/users

Long Description

A user is an employee at a brokerage. This endpoint will return a list of users for your brokerage.

Parameters

Name	Description	Value Type	Required
name	Name of the user	String	Optional
email	Email of the user	String	Optional
updated_at	An ISO 8601 date or datetime	String	Optional
office_id	ID of the office the users belong to	Integer	Optional
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

Paste in Request Code

{
            "total_entries" => 1398,
             "current_page" => 1,
                    "users" => [
                [0] {
                         "email" => "ram@goldentickets.com",
                    "updated_at" => "2011-10-05T16:45:40Z",
                         "phone" => {
                           "number" => "972-424-2377",
                        "extension" => nil
                    },
                          "name" => "Ram Silverman",
                        "office" => {
                             "name" => "Main Office",
                        "brokerage" => {
                            "abbreviation" => "Golden Tickets",
                                    "name" => "Golden Tickets",
                                      "id" => "2",
                                     "url" => "/brokerages/2"
                        },
                              "url" => "/offices/141",
                               "id" => "141"
                    },
                           "url" => "/users/19",
                            "id" => "19"
                },
                [1] {
                         "email" => "duane@minnetonkatickets.com",
                    "updated_at" => "2011-10-05T18:25:31Z",
                         "phone" => {
                           "number" => nil,
                        "extension" => nil
                    },
                          "name" => "Duane Thilmony",
                        "office" => {
                             "name" => "Main Office",
                        "brokerage" => {
                            "abbreviation" => "Minnetonka",
                                    "name" => "Minnetonka Tickets",
                                      "id" => "3",
                                     "url" => "/brokerages/3"
                        },
                              "url" => "/offices/161",
                               "id" => "161"
                    },
                           "url" => "/users/20",
                            "id" => "20"
                }
            ],
                 "per_page" => 2
}