List users

get

https://api.epicorretailcloud.com/api/organization/v1/user/

Returns a paginated list of users.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

callback_url

uri

length ≥ 1

This URL will be invoked when results are ready for retrieval. The payload will contain the location of the results file. Use the Check Deferred Execution Status API to poll for status, or include a value for callback_url to be notified when results are ready.

create_datetime

date-time | null

Filter upon the create date/time using ISO8601 format. Assumption is UTC unless TZ offset is specified.

integer

deprecated

Filter upon User ID. (Deprecated, use user_id instead.)

is_active

boolean

If False, this user is treated as inactive.

is_async

boolean

Set to true to request asynchronous processing, which is required for larger data requests.

limit

integer

Maximum number of results per page. The default is 25.

ordering

string

Fields to order upon. Valid fields include: user_id, id, create_datetime, update_datetime

page

integer

Page of results to retrieve

string

Term(s) to search for. The following fields will be searched: username, display_name, first_name, last_name, employee_number, email, create_datetime, update_datetime

update_datetime

date-time | null

Filter upon the update date/time using ISO8601 format. Assumption is UTC unless TZ offset is specified.

user_id

integer

The unique system assigned value that identifies this record.

username

string

length ≥ 1

Required. 30 characters or fewer. Letters, digits and ./-/_ only.

Headers

X-Active-Store

integer

required

The id of the active store to be used for this API invocation

Responses

200

202Request accepted for asynchronous processing.

413Too many results. Use async processing by specifying 'is_async' or 'callback_url'.

429Too many queued requests for 'tenant' and 'endpoint'. Please try again later