WOworkiz
Users

Retrieve a single User

Changed on

Retrieves a single User by its ID.

get/v2/users/{id}

Request

Path parameters

idstring required
Example:USR-A21Lz3rPQxkYqRNo

The user ID (prefix USR-).

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

The requested User.

idstring

The ID of the user (prefix USR-).

namestring

The name of the user.

emailAddressstring

The email address of the user.

cellPhonestring

The phone number of the user.

addressstring

The address of the user.

rolestring

The role of the user.

fieldTechboolean

Whether the user is a field technician and can be assigned to jobs.

activeboolean

Whether the user is active.

notesstring

Notes about the user.

Example response

{
  "id": "USR-38c1ee5c4efa38a4",
  "name": "John Smith",
  "emailAddress": "john.doe@gmail.com",
  "cellPhone": "1234567890",
  "address": "1234 Elm Street, Apt 5B, Springfield, IL 62701, USA",
  "role": "tech",
  "fieldTech": true,
  "active": true,
  "notes": "This is a note",
  "jobTypes": [
    {
      "id": "JT-8718036049ec4c4d",
      "name": "Repair"
    }
  ],
  "serviceAreas": [
    {
      "id": "SA-71b8d7310acbf8cc",
      "name": "San Francisco"
    }
  ]
}

Changes

  • a2110eaa32f2Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status