Difference between revisions of "Get Mobile Users"
From MyMobileWorkers API
(→Summary) |
(→Example curl request) |
||
| Line 63: | Line 63: | ||
== Example curl request == | == Example curl request == | ||
| − | http://live.mymobileworkers.com:8080/api/1/mobile_users?api_key=YOURAPIKEY | + | http://live.mymobileworkers.com:8080/api/1/mobile_users?api_key=YOURAPIKEY&include_deleted=false |
Revision as of 11:27, 31 May 2016
Contents |
Summary
| Mobile Users | ||
|---|---|---|
| URL | http://:base_url/:api_path/:version/mobile_users | |
| Type | GET | |
| Params: | api_key | required |
| branch_id | optional | |
| include_deleted | optional (default = true) | |
| Response | JSON | |
The mobile users method returns a list of all mobile users for your company unless the branch id is specified.
Response Parameters
| Field | Description |
|---|---|
| username | Mobile username |
| email_address | Email address |
| color | Hex Colour used within MMW to identify the user (see the calendar) |
| engineer_registration_number | The users gas safe engineer ID if provided. |
Example response
[ {"username":"USER1","email":"ryanmt@nospam.com","color":"D7C863","engineer_registration_number":null}, {"username":"USER2","email":"bobbob@nospam.com","color":"97326A","engineer_registration_number":null}, {"username":"USER3","email":"sdfasdf@nospam.com","color":"56500D","engineer_registration_number":null}, {"username":"USER4","email":"asdsdf@nospam.com","color":"C1C355","engineer_registration_number":null}, {"username":"USER5","email":"asdfds@nospam.com","color":"FA556A","engineer_registration_number":null} ]
Example curl request
http://live.mymobileworkers.com:8080/api/1/mobile_users?api_key=YOURAPIKEY&include_deleted=false
