This is an old revision of the document!

Servers

Users

User Object

Description

A direct user of the system. Could be an organization employee or customer.

Fields

Field	Type	Optional	Subtypes	Description
id
email
fist name
last name
address
organization
is owner

JSON Sample

{

"email" : "first.last@example.com",
"first_name" : "Doug",
"last_name" : "Kurth",
"user_type" : "Customer",
"is_professional" : false,
"id" : 12345,
"is_active" : false

}

GET users

Description

Get the details for all users visible by the requester

Resource URL https://api.optionscity.com/users

Authentication	Required
HTTP Methods	GET
Media Types	application/json
Response Object	User
Response Type	Standard

Name	Description	Required?	Type
page	1-indexed page to retrieve. Default is 1.	No	Number
per_page	Number of entries returned per page. Default is 20.	No	Number
email	Get the user registered with this email address.	No	String
query	Search for users matching this query by name	No	String

Example Request GET https://api.optionscity.com/users

Example Response

[ {

"email" : "first.last@example.com",
"first_name" : "Doug",
"last_name" : "Kurth",
"user_type" : "Customer",
"is_professional" : false,
"id" : 12345,
"is_active" : false

} ]