get-users

get

get-users

{Beta} Retrieves a list of users including details about each user and its nested objects.

Resource URL

https://api.pepperi.com/v1.0/users

Query Parameters

Name
Values
Description
page
Page index.
page_size
Number of records per page. (100 by default, 250 max)
where
Filter results by SQL-Style where clause.
order_by
Defines the sort order of the results.
fields
Return specified fields only. (comma delimited)
include_deleted
Include records in "Hidden" status.
include_nested
Include one-to-many nested objects.
include_count
Include records and pages counting as custom headers.
full_mode
Include all fields of one-to-one related objects.
is_distinct
When set to true retrieves distinct values based on the fields parameter.

HTTP Basic:

Request to:

Consumer Key:

Response Error Details

  • Request
  • Response
  • cURL
Make a request and see the response.
Make a request and see the response.
Make a request and see the response.