FUfulcrumpro
User

Find users based on search parameters.

Changed on
post/api/users/list

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/users/list
  • Auth
    none declared

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

Request body

firstNamestring nullable

Filter users based on their first name.

lastNamestring nullable

Filter users based on their last name.

emailAddressstring nullable

Email address

phoneNumberstring nullable

Phone number

rolesstring[] nullable

Filter users to those with any of the provided roles.

omniSearchstring nullable

Search for users based on a string that should match any of the user's first name, last name, email address, phone number or roles.

includeDeletedboolean

When true, inactive/deleted users are included in the results. Defaults to false, in which case only active users are returned.

Response

List of users matching the filters

idstring required

Unique id associated to this entity.

employeeIdstring nullable

This property represents the unique identifier of an employee.

firstNamestring nullable

First name

lastNamestring nullable

Last name

emailAddressstring email nullable

Email address

phoneNumberstring nullable

Email address

deletedboolean

Indicates whether this user has been deleted

Changes

  • 6fc46fb4f45bRevision changes
    • info

      added the new optional request property (media type: application/json-patch+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/problem+json)

  • 30a13c1e996eRevision changes
    • info

      for the query request parameter Take, the max was increased from 1000.00 to 5000.00

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/problem+json)