GET /api/v1/users

GET /api/beta/users

Get all rows that match the values provided for all column-name parameters used. If the value starts with a tilde ('~'), the rest of the value is treated as a regular expression to match and the matching is case insensitive. Otherwise, the column value must match the parameter value exactly.

Params

Param name Description
limit
optional

Sets an upper bound on the number of results to return. Defaults to 200.

Validations:

  • Must match regular expression /^([1-9][0-9]*|all|none)$/.

offset
optional

Set the number of rows to skip before returning matching rows.

Validations:

  • Must match regular expression /[1-9][0-9]*/.

key
optional

The API key to use for authorization.

associations_mode
optional

Set the amount of data to display about associations. Default is “full_info” for the show action and “count” for the index action.

Validations:

  • Must be one of: full_info, ids, count.

id
optional
login
optional

login id

name
optional

User name

email
optional

email address

city
optional
country
optional
area
optional
crypted_password
optional
salt
optional
created_at
optional
updated_at
optional
remember_token
optional
remember_token_expires_at
optional
access_level
optional

data to which user has access

page_access_level
optional

Determines the extent of data, if any, that user can edit.

apikey
optional
state_prov
optional
postal_code
optional

GET /api/v1/users/:id

GET /api/beta/users/:id

Get all information about the row with the matching id value. Information about associated rows (those reference by foreign keys) is shown as well.

Params

Param name Description
key
optional

The API key to use for authorization.

associations_mode
optional

Set the amount of data to display about associations. Default is “full_info” for the show action and “count” for the index action.

Validations:

  • Must be one of: full_info, ids, count.