Sign in
Users

Get Users

Changed on

Retrieves users within the organization.

Filtering

This endpoint supports optional filtering in one of the following ways:

Note: These filters cannot be combined.

Pending (invitation)

Add pending=(true|false) in the query parameters with one of the following options:

  • true - Return only disabled users
  • false - Return only active users

Deleted (deactivated)

Add deleted=(true|false) in the query parameters with one of the following options:

  • true - Return only deactivated users
  • false - Return only active users

User Type

Add userType=[userType] in the query parameters with one of the following options:

  • user - Full user
  • machine - Machine user / API user
  • limited - Collaborator user

Email

Add email=[email] in the query parameter to filter for a specific user email address.

get/users

Request

  • Base URL: https://api.kustomerapp.com/v1
  • URL: https://api.kustomerapp.com/v1/users
  • Auth: httpBearer (a scheme the document does not define)

Query parameters

pendingboolean
Example:true

Invitation status of user. true returns only users with a pending invitation. false returns only active users.

deletedboolean

Activation status of user. true returns only deactivated users. false returns only active users.

userType'user' | 'machine' | 'limited'
Example:user

User type. Options: user for full users, machine for a machine user or API user, and limited for collaborator user.

emailstring email
Example:franz.kafka@kustomer.com

User email address.

Response

OK

Changes