kustomer-client
    Preparing search index...

    Function getUsers

    • Get Users Retrieves users within the organization.

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

      Note: These filters cannot be combined.

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

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

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

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

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

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

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

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      createdAt: string;
                      displayName: null
                      | string;
                      email: string;
                      mobile: null | string;
                      name: string;
                      roles: string[];
                      updatedAt: string;
                      userType: string;
                  };
                  id: string;
                  links: { self: string };
                  relationships: {
                      org: { data: { id: string; type: string }; links: { self: string } };
                  };
                  type: string;
              }[];
              links: {
                  first: string;
                  next: null
                  | string;
                  prev: null | string;
                  self: string;
              };
              meta: { page: number; pageSize: number };
          },
          unknown,
          ThrowOnError,
      >

    Settings

    Member Visibility

    On This Page

    Filtering