User Find
Protocol
POST
URL
https://api.helpmonks.com/api/v1/user/find
Parameters
Name | Required | Value | Comment |
---|---|---|---|
query | Yes | Available column in object | |
fields | No | Available column name | |
options | No | Available options like sort, slice, etc. |
The available fields are documented in the User Data Model. Refer to the Query syntax documentation on how to query against your records
Example
{
query : { 'first_name' : 'Nitai', 'email' : 'nitai@helpmonks.com' },
fields : { 'first_name email' },
options : { sort : { first_name: 'asc' } }
}
Returned data
Please refer to the User Data Model to see the data structure being returned