GET/desk/api/v2/users.json

List users for current installation.

The following values are allowed in the filter query parameter:

  • autoFollowOnCC
  • avatarURL
  • createdAt
  • createdBy
  • editMethod
  • email
  • firstName
  • firstname
  • id
  • inboxes.id
  • isPartTime
  • lastName
  • lastname
  • reviewer
  • role
  • sendPushNotifications
  • sendWebNotifications
  • state
  • ticketReplyRedirect
  • trainingWheelsEnrollment
  • triggers.id
  • updatedAt
  • updatedBy
  • users.ontraining

The following values are allowed in the orderBy query parameter:

  • autoFollowOnCC

  • avatarURL

  • createdAt

  • createdBy

  • editMethod

  • email

  • email

  • firstName

  • firstname

  • id

  • isPartTime

  • isPartTime

  • lastName

  • lastname

  • reviewer

  • role

  • role

  • sendPushNotifications

  • sendWebNotifications

  • state

  • ticketReplyRedirect

  • trainingWheelsEnrollment

  • updatedAt

  • updatedBy

         The following values are allowed in the [includes](https://apidocs.teamwork.com/guides/desk/relationships-and-includes) query parameter:

  • inboxes

  • permissionusers

  • trainingwheelsenrollments

  • users

  • all

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    UsersAPIBody handles request/response for user listing
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

Examples

200 OK

UsersAPIBody
{  "included": {    "inboxes": [      {        "autoReplyEnabled": true,        "autoReplyFromUserId": 0,        "autoReplyMessage": "string",        "autoReplySubject": "string",        "clientOnly": true,        "createdAt": "2024-10-18T23:59:26.347Z",        "createdBy": {          "delete": true,          "id": 0,          "meta": {            "additionalProp": "Unknown Type: any"          },          "type": 0        },
Download Swagger