Get Users

get

https://platform.{env}.simpplr.com/v1/b2b/identity/users

This API allows you to get all users of a tenant.

Query Params

pageSize

integer

Defaults to 50

The number of users to return per page.

pageToken

string

Should be a integer returned as nextPageToken from previous page request

parseCustomFields

string

enum

Defaults to false

Whether to parse custom fields (if custom field types enabled)

Allowed:

includeTotal

boolean

Defaults to false

Whether to include the total number of users in the response. To include set it to true

fields

enum

Comma separated list of fields to include in the response. use all to include all fields use minimal to include only the login identifiers use comma separated field names to include specific fields Ex: firstName,lastName,etc

use all to include all fields use minimal to include only the login identifiers

modifiedAfter

date-time

Filter users modified after this date-time. Must be in ISO 8601 UTC format (e.g. 2025-04-09T18:30:00.000Z)

sortBy

string

Field to sort the users by value can be csv Ex: firstName:ASC,lastName:DSC

employeeNumber

string

filter users by employee number

firstName

string

filter users by first name

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Validation Error Response

401Authorize error

403Forbidden error