Skip to main content

Get all user accounts

GET
/partner/v1.0/users

Retrieves the user account list.


Headers​

  • Accept : application/json
  • Content-Type : application/json
  • Authorization : Bearer {access_token}

Query Parameters​

page number Optional
Indicates which specific page of results you want to retrieve. The default value is 1.
page_size number Optional
Indicates how many items should be included in each page of results. The default value is 25.
sort_by string Optional
Comma separated sortable fields (e.g., name, +name, -name, email, +email, -email).
q string Optional
Keyword to filter with user account name or email.


Response​

200 OK.

Parameters
total_count number
The total number of user accounts.
result array object
The list of user accounts.
Child Parameters
id string (uuid)
The unique identifier in the Pulsifi system for the user account.
user_account_id number
The user account id for the user.
status enum (default is active)
The status of the user
  • active
  • pending
  • not_invited
  • disabled
first_name string
The first name of the user.
last_name string
The last name of the user.
email string
The email of the user.
department string
The department of the user.
position string
The position of the user.
external_employee_id string
The external employee id reference of the user.
last_login_at string (UTC Date)
The last login date of the user.
GET /users
curl -X GET 'https://staging.api.pulsifi.me/partner/v1.0/users?page={page}&page_size={limit}&sort_by={string}&q={string}' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
Response
{
  "data": {
      "total_count": 1,
      "result":  [
        {
          "id": "<Pulsifi User ID>",
          "user_account_id": "<User Account ID>",
          "status": "active",
          "first_name": "<First Name>",
          "last_name": "<Last Name>",
          "email": "<Email>",
          "department": "<Department>",
          "position": "<Position>",
          "external_employee_id": "<External Employee ID>",
          "last_login_at": "<Last Login At>",
        }
      ]
  },
  "meta": null
}