API Reference

getApplicationUsersByPage

get
https://webservices-test.net-chef.com/applicationuser/v1/getApplicationUsersByPage

Retrieve a list of Application Users across multiple pages. Include additional details (e.g. User/Locations(s), User/Market(s), etc.) for a single Application User or all Application Users by using the includeDetails parameter. Default page size is 10 Application Users, including their details if includeDetails is true.

Query Params
boolean

Use true to limit retrieval to active Application Users. Use false to limit retrieval of inactive Application Users. Omit to retrieve all Application Users.

boolean
Defaults to false

Use true to retrieve detailed information for each Application User.

int32
Defaults to 1

Provide the page number to retrieve Application Users on a particular page. Default is 1 when no 'pageNumber' value provided.

int32

Number of items to display per page.

string

Provide the userId for a specific Application User to limit retrieval of that Application User's information. Add includeDetails = true for complete Application User information.

boolean

Specify 'true' to output null data elements.

int32

The number of minutes since an application user record was last updated. Use to set how far back to search.

Headers
string
required

Secure token for API authentication.

string
required

Password for the Crunchtime Application User.

string
required

Crunchtime site identifier. (test or production)

string
required

User ID for the Crunchtime Application User.

string

Optional trace identifier for troubleshooting.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 5 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json
Updated 5 months ago