API Reference

getEmployeesByPageV1

get
https://webservices-test.net-chef.com/employee/v1/getEmployeesByPage

Get Employees By Page

Query Params
boolean
Defaults to false

Include Audits to retrieve (optional)

string

Include Locations (All,True,False) to retrieve (optional)

boolean
Defaults to true

Include Positions to retrieve (optional)

string
Defaults to false

Include Terminated to retrieve (optional)

string

The Code that identifies the Location in Crunchtime.

int32

The number of minutes since an employee record was last updated. Use to set how far back to search. (optional).

int32
Defaults to 1

Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 10.

int32

Number of items to display per page.

string

Earliest date in search range (optional). Format: yyyy-MM-dd'T'HH:mm:ss

string

Latest date in search range (optional). Format: yyyy-MM-dd'T'HH:mm:ss

boolean

Specify 'true' to output null data elements.

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