/
Users / List

Users / List

Owned by Ian Grabill (Unlicensed)
Last updated: Jul 11, 2013Version comment
NameIndex
DescriptionReturn all users for a brokerage
TypeGET
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
nameName of the userStringOptional
emailEmail of the userStringOptional
updated_atAn ISO 8601 date or datetimeStringOptional
office_idID of the office the users belong toIntegerOptional
pageNumber of pages that you want to returnIntegerOptional
per_pageNumber of results returned per pageIntegerOptional

 

Examples

RequestResponse
/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
}

Related content