SAsalussafety
Users

Search Users

Changed on

Search for users that match the provided search terms.

Keywords are searched for in the firstname, lastname, email, address, and phone numbers (home, work and mobile) fields.

get/v1/user/

Request

  • Base URL
    https://developer.beta.salussafety.io
  • URL
    https://developer.beta.salussafety.io/v1/user/
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: https://guardian.beta.salussafety.io/token
    • or OAuth 2
      Authorization code: https://guardian.beta.salussafety.io/authorize
      Token URL: https://guardian.beta.salussafety.io/token

Query parameters

querystring nullable
skipinteger nullable
limitinteger nullable
sort_direction'asc' | 'desc'

Direction to sort the sort_column - ascending or descending.

date_startstring date-time nullable
date_cut_offstring date-time nullable
sort_column'updated_at' | 'created_at' | 'id'

Which column to sort on

is_activeboolean nullable
role_idinteger nullable
is_adminboolean nullable

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": [
    {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "email": "j.doe@example.com",
      "companyUser": {
        "id": 1275,
        "role": {
          "id": 4,
          "name": "Foreman",
          "slug": "foreman"
        },
        "isActive": true,
        "employeeId": "EM00123",
        "position": "Office Manager"
      }
    }
  ]
}

Changes