Users

Manage users in TeamPulse.

GET /users/{id} - Get user by ID

GET /users/me - Get current user

GET /users - Get all licensed users.

User Model

The object representing a user has the following properties:

id: integer - ID of the user.

name: string - Username of the user.

firstName: string - First name of the user.

lastName: string - Last name of the user.

displayName: string - User display name.

email: string - User email.

Resource Url

To make API requests use the URL [teampulse]/api/v1 where [teampulse] is the URL to the TeamPulse instance which you want to manage via the API.

Example:
[teampulse]/api/v1/users

Get a user

GET /users/{id}

Response

HTTP/1.1 200

{
  "id": 11,
  "name": "harris",
  "firstName": "Dave",
  "lastName": "Harris",
  "displayName": "Dave Harris",
  "email": "dave.harris@telerik.com"
}

Get current user

GET /users/me

Response

HTTP/1.1 200

{
  "id": 8,
  "name": "AnnieLowe",
  "firstName": "Annie",
  "lastName": "Lowe",
  "displayName": "Annie Lowe",
  "email": "annie@telerik.com"
}

Get users

GET /users : Get all licensed users.

OData $filter and $orderby options can be supplied to filter and order the results. $top and $skip to get top N items and skip the top M. Read more how to use the OData options

Response

HTTP/1.1 200

{
  "totalResults": 2,
  "top": 2,
  "results": [
    {
        "id": 1,
        "name": "AnnieLowe",
        "firstName": "Annie",
        "lastName": "Lowe",
        "displayName": "Annie Lowe",
        "email": "annie@telerik.com"
    },
    {
        "id": 2,
        "name": "harris",
        "firstName": "Dave",
        "lastName": "Harris",
        "displayName": "Dave Harris",
        "email": "dave.harris@telerik.com"
    }
  ]
}