Users

Lists the organization's users with the schedule groups each belongs to.

Users are keyed by string ids, so this collection is <b>not</b> cursor-paginated: the whole list is returned in one response (ordered by first then last name) with nextCursor always null. The response carries an ETag; send it as If-None-Match to get 304 when nothing changed. Example: GET /api/v1/users?scheduleGroupId=5 returns the members of group 5. Also available as CSV (Accept: text/csv or ?format=csv); paging cursor in X-Next-Cursor.

get/api/v1/users

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/users
  • Auth: HTTP bearer

Query parameters

includeInactiveboolean

Also return deactivated accounts (default false).

scheduleGroupIdinteger

Only users who are members of this schedule group.

format'csv'

Alternative to the Accept header: csv returns text/csv.

Response

All matching users.

nextCursorstring nullable

SyncId of the last item; pass it back as ?after= to fetch the next page. null when this is the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.