FEfergus
Users

GET /users

Returns a list of users. The list can be filtered by first name, last name or email.

Request

  • Base URL
    https://api.fergus.com
  • Auth
    • OAuth 2
      Authorization codehttps://auth.fergus.com/oauth2/authorize
      Token URLhttps://auth.fergus.com/oauth2/token
    • or HTTP bearer
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

pageSizeinteger
'asc'
OR
'desc'
pageCursorstring
sortField'firstName' | 'lastName' | 'createdAt'
filterUserType'contractor' | 'time_sheet_only' | 'field_worker' | 'apprentice' | 'tradesman' | 'advisor' | 'full_user'
filterStatus'active' | 'disabled' | 'invited'
filterSearchTextstring

Searchable fields:

  • firstName
  • lastName
  • employee's username
  • email
  • address.address1
  • address.address2

Response

Successful Response

resultstring required

Changes

No recorded changes to this operation across all 18 revisions of this API.