Skip to main content

List Users

This API can be used by MSP Partners to list users with filtering. sort and pagination support.

Response Body

FieldDescriptionTypeNotes
dataList of UsersUser Objects (Get Use by Id - Response Body) ArraySee - Get User by Id - User Object (Response Body)
metadataList user metadataMetadata ObjectSee - Metadata Object
Metadata Object
FieldDescriptionTypeNotes
filterFilter string that contains search parametersString
sortSort string that contains sorting criteriaString
paginationPagination InfoPagination ObjectSee - Pagination Object
Pagination Object
FieldDescriptionTypeNotes
pageNumberPage numberInteger0 to x
pageSizePage sizeInteger
totalRecordsTotal number of recordsInteger
Query Parameters
  • filter string

    Optional - Filter. Only searchTerm supported which matches user firstName lastName and email containing searchTerm value.

  • sort string

    Optional - Sort order. default desc:updateTs

  • pageNumber int32

    Optional - Page number >=0. default 0

  • pageSize int32

    Optional - Size of each page. default 25

Responses

OK


Schema
    Loading...