List users

get

https://{tenant}{.kallidus-suite.com}/api/v4/suite/users

View all users.

Query Params

$filter

string

OData like filter expression. Supported operators: eq, ne, and.
Supported fields: id, username, importKey, givenName, familyName, emailAddress, isEnabled.
Examples:

givenName eq 'John'
importKey eq 'EMP001'
isEnabled eq true
familyName eq 'Smith' and isEnabled eq true

$orderby

string

Order results by one or more fields. Use 'asc' or 'desc' for direction.
Supported fields: id, username, created, givenName, familyName, emailAddress, isEnabled.
Defaults to created asc, id asc when omitted.
Example: familyName asc, givenName asc

$top

integer

1 to 50

Defaults to 10

Number of records to return (page size)

$count

boolean

Defaults to false

Include total count of matching records in response

$select

string

Comma-separated list of fields to include in response.
Example: id,givenName,familyName,emailAddress

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

URL

Loading…

Response

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

application/json

application/problem+json

200Users retrieved successfully

400Bad Request

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

500Internal Server Error