v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB

Users

List all users

🔑

Required OAuth scope: users:read.

📖

This endpoint is paginated with a page size of 500 users. For more information, see the Pagination guide.

Lists all users in your platform.

get/api/v2/users

Query parameters

eqstring

Filter on values equal to the given one

nestring

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on mail property with LHS bracket notation.

Expected value format is a string.

{
  "eq": "loremIpsum",
  "ne": "loremIpsum",
  "in": [
    "loremIpsum"
  ],
  "nin": [
    "loremIpsum"
  ]
}

eqstring

Filter on values equal to the given one

nestring

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on username property with LHS bracket notation.

Expected value format is a string.

{
  "eq": "loremIpsum",
  "ne": "loremIpsum",
  "in": [
    "loremIpsum"
  ],
  "nin": [
    "loremIpsum"
  ]
}

eq'active' | 'invited' | 'deleted'

Filter on values equal to the given one

ne'active' | 'invited' | 'deleted'

Filter on values not equal to the given one

Filter on status property with LHS bracket notation.

Expected value format is a string (active, invited, deleted).

{
  "eq": "active",
  "ne": "active"
}

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns one page of 500 users.

_idstring ObjectId required

The unique ID of the user.

mailstring

The email address of the user.

usernamestring

The username that can be used to log in if the company allows it.

status'active' | 'invited' | 'deleted' required

The status of the user.

lang'bg' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'es' | 'fi' | 'fr' | 'hr' | 'ht_HT' | 'hu' | 'id' | 'it' | 'ja' | 'kar_MM' | 'ko' | 'lt' | 'mh_MH' | 'nl' | 'nl_BE' | 'no' | 'pl' | 'pt' | 'ro' | 'ru' | 'rw_RW' | 'sk' | 'sl' | 'so_SO' | 'sv' | 'sw_KE' | 'th' | 'ti_ET' | 'tr' | 'uk' | 'zh' | 'vi' required

The default language of the user, in a bigram format (en, fr, de, etc.).

firstNamestring

The first name of the user.

lastNamestring

The last name of the user.

jobstring

The role title of the user.

organizationstring

The organization that the user belongs to.

phonestring

The phone number of the user.

customstring

The value of the Additional information field in the user’s profile. This is not the value of the custom fields associated with the user.

deletedAtstring[]

The list of dates and times when the user’s profile was soft deleted, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

primaryGroupIdstring ObjectId

The unique ID of the primary group of the user.

reactivatedAtstring[]

The list of dates and times when the user’s profile was reactivated, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

lastLoginDatestring date-time

The date and time when the user last logged in, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

toBeDeactivatedAtstring date-time

The date and time when the user will be deactivated, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

profileImageIdstring ObjectId

The unique ID of the profile image of the user.

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "mail": "john.smith@yopmail.com",
    "username": "johnsmith",
    "firstName": "John",
    "lastName": "Smith",
    "job": "Engineer",
    "organization": "360Learning",
    "phone": "+33123456789",
    "custom": "Half-time worker",
    "primaryGroupId": "507f1f77bcf86cd799439011",
    "profileImageId": "507f1f77bcf86cd799439011"
  }
]