GET api/users/search?active={active}&username={username}&firstName={firstName}&lastName={lastName}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of users.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
active

Filter users on whether they are active or not.

 boolean

None.
username

Filter users by username.

 string

Default value is empty string ("")
firstName

Filter users by name.

 string

Default value is empty string ("")
lastName

Filter users by last name.

 string

Default value is empty string ("")
page

Page number requested (search results are paginated).

 integer

Default value is 1
itemsPerPage

Number of items to return on each page (search results are paginated).

 integer

Default value is 10

Body Parameters

None.

Response Information

Resource Description

ListModelOfUserModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.
ItemsPerPage

integer

None.
CurrentPage

integer

None.
TotalPages

integer

None.
FirstRowOnPage

integer

None.
LastRowOnPage

integer

None.
Rows

Collection of UserModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "totalItems": 1,
  "itemsPerPage": 2,
  "currentPage": 3,
  "totalPages": 4,
  "firstRowOnPage": 5,
  "lastRowOnPage": 6,
  "rows": [
    {
      "username": "sample string 1",
      "password": "sample string 2",
      "passwordConfirmation": "sample string 3",
      "active": true,
      "notes": "sample string 5",
      "upDoxId": "sample string 6",
      "contact": {
        "id": "c8e491fe-3922-4786-9dc8-59187b7214fb",
        "firstName": "sample string 2",
        "middleName": "sample string 3",
        "lastName": "sample string 4",
        "suffix": "sample string 5",
        "prefix": "sample string 6",
        "fullName": "sample string 7",
        "companyName": "sample string 8",
        "jobTitle": "sample string 9",
        "emailAddresses": [
          {
            "id": "b003d6e5-e871-4ad0-bcd3-99fc98401db6",
            "alias": "sample string 2",
            "address": "sample string 3",
            "default": true,
            "sortOrder": 5
          },
          {
            "id": "b003d6e5-e871-4ad0-bcd3-99fc98401db6",
            "alias": "sample string 2",
            "address": "sample string 3",
            "default": true,
            "sortOrder": 5
          }
        ],
        "phoneNumbers": [
          {
            "id": "037bc0f6-f211-43c5-b006-95feea5fdfb7",
            "alias": "sample string 2",
            "number": "sample string 3",
            "default": true,
            "useForSms": true,
            "sortOrder": 6
          },
          {
            "id": "037bc0f6-f211-43c5-b006-95feea5fdfb7",
            "alias": "sample string 2",
            "number": "sample string 3",
            "default": true,
            "useForSms": true,
            "sortOrder": 6
          }
        ],
        "postalAddresses": [
          {
            "id": "08e30f78-cbcd-4a72-9e27-0fe64537f13d",
            "alias": "sample string 2",
            "address1": "sample string 3",
            "address2": "sample string 4",
            "city": "sample string 5",
            "state": "sample string 6",
            "countryId": "583ba77c-13ef-4dce-ab3b-5337fbde1488",
            "countryCode": "sample string 7",
            "countryName": "sample string 8",
            "zip": "sample string 9",
            "default": true
          },
          {
            "id": "08e30f78-cbcd-4a72-9e27-0fe64537f13d",
            "alias": "sample string 2",
            "address1": "sample string 3",
            "address2": "sample string 4",
            "city": "sample string 5",
            "state": "sample string 6",
            "countryId": "583ba77c-13ef-4dce-ab3b-5337fbde1488",
            "countryCode": "sample string 7",
            "countryName": "sample string 8",
            "zip": "sample string 9",
            "default": true
          }
        ],
        "notes": "sample string 10"
      },
      "locations": [
        "sample string 1",
        "sample string 2"
      ],
      "id": "79003a49-6c48-4e62-9c14-349ae80497df",
      "externalId": "sample string 8"
    },
    {
      "username": "sample string 1",
      "password": "sample string 2",
      "passwordConfirmation": "sample string 3",
      "active": true,
      "notes": "sample string 5",
      "upDoxId": "sample string 6",
      "contact": {
        "id": "c8e491fe-3922-4786-9dc8-59187b7214fb",
        "firstName": "sample string 2",
        "middleName": "sample string 3",
        "lastName": "sample string 4",
        "suffix": "sample string 5",
        "prefix": "sample string 6",
        "fullName": "sample string 7",
        "companyName": "sample string 8",
        "jobTitle": "sample string 9",
        "emailAddresses": [
          {
            "id": "b003d6e5-e871-4ad0-bcd3-99fc98401db6",
            "alias": "sample string 2",
            "address": "sample string 3",
            "default": true,
            "sortOrder": 5
          },
          {
            "id": "b003d6e5-e871-4ad0-bcd3-99fc98401db6",
            "alias": "sample string 2",
            "address": "sample string 3",
            "default": true,
            "sortOrder": 5
          }
        ],
        "phoneNumbers": [
          {
            "id": "037bc0f6-f211-43c5-b006-95feea5fdfb7",
            "alias": "sample string 2",
            "number": "sample string 3",
            "default": true,
            "useForSms": true,
            "sortOrder": 6
          },
          {
            "id": "037bc0f6-f211-43c5-b006-95feea5fdfb7",
            "alias": "sample string 2",
            "number": "sample string 3",
            "default": true,
            "useForSms": true,
            "sortOrder": 6
          }
        ],
        "postalAddresses": [
          {
            "id": "08e30f78-cbcd-4a72-9e27-0fe64537f13d",
            "alias": "sample string 2",
            "address1": "sample string 3",
            "address2": "sample string 4",
            "city": "sample string 5",
            "state": "sample string 6",
            "countryId": "583ba77c-13ef-4dce-ab3b-5337fbde1488",
            "countryCode": "sample string 7",
            "countryName": "sample string 8",
            "zip": "sample string 9",
            "default": true
          },
          {
            "id": "08e30f78-cbcd-4a72-9e27-0fe64537f13d",
            "alias": "sample string 2",
            "address1": "sample string 3",
            "address2": "sample string 4",
            "city": "sample string 5",
            "state": "sample string 6",
            "countryId": "583ba77c-13ef-4dce-ab3b-5337fbde1488",
            "countryCode": "sample string 7",
            "countryName": "sample string 8",
            "zip": "sample string 9",
            "default": true
          }
        ],
        "notes": "sample string 10"
      },
      "locations": [
        "sample string 1",
        "sample string 2"
      ],
      "id": "79003a49-6c48-4e62-9c14-349ae80497df",
      "externalId": "sample string 8"
    }
  ]
}

application/xml, text/xml

Sample: 
<ListModelOfUserModelaJigm_Sbl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">
  <CurrentPage>3</CurrentPage>
  <FirstRowOnPage>5</FirstRowOnPage>
  <ItemsPerPage>2</ItemsPerPage>
  <LastRowOnPage>6</LastRowOnPage>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Users">
    <d2p1:UserModel>
      <ExternalId>sample string 8</ExternalId>
      <Id>79003a49-6c48-4e62-9c14-349ae80497df</Id>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Contact xmlns:d4p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Contacts">
        <d4p1:CompanyName>sample string 8</d4p1:CompanyName>
        <d4p1:EmailAddresses>
          <d4p1:EmailAddressModel>
            <d4p1:Address>sample string 3</d4p1:Address>
            <d4p1:Alias>sample string 2</d4p1:Alias>
            <d4p1:Default>true</d4p1:Default>
            <d4p1:Id>b003d6e5-e871-4ad0-bcd3-99fc98401db6</d4p1:Id>
            <d4p1:SortOrder>5</d4p1:SortOrder>
          </d4p1:EmailAddressModel>
          <d4p1:EmailAddressModel>
            <d4p1:Address>sample string 3</d4p1:Address>
            <d4p1:Alias>sample string 2</d4p1:Alias>
            <d4p1:Default>true</d4p1:Default>
            <d4p1:Id>b003d6e5-e871-4ad0-bcd3-99fc98401db6</d4p1:Id>
            <d4p1:SortOrder>5</d4p1:SortOrder>
          </d4p1:EmailAddressModel>
        </d4p1:EmailAddresses>
        <d4p1:FirstName>sample string 2</d4p1:FirstName>
        <d4p1:FullName>sample string 7</d4p1:FullName>
        <d4p1:Id>c8e491fe-3922-4786-9dc8-59187b7214fb</d4p1:Id>
        <d4p1:JobTitle>sample string 9</d4p1:JobTitle>
        <d4p1:LastName>sample string 4</d4p1:LastName>
        <d4p1:MiddleName>sample string 3</d4p1:MiddleName>
        <d4p1:Notes>sample string 10</d4p1:Notes>
        <d4p1:PhoneNumbers>
          <d4p1:PhoneNumberModel>
            <d4p1:Alias>sample string 2</d4p1:Alias>
            <d4p1:Default>true</d4p1:Default>
            <d4p1:Id>037bc0f6-f211-43c5-b006-95feea5fdfb7</d4p1:Id>
            <d4p1:Number>sample string 3</d4p1:Number>
            <d4p1:SortOrder>6</d4p1:SortOrder>
            <d4p1:UseForSms>true</d4p1:UseForSms>
          </d4p1:PhoneNumberModel>
          <d4p1:PhoneNumberModel>
            <d4p1:Alias>sample string 2</d4p1:Alias>
            <d4p1:Default>true</d4p1:Default>
            <d4p1:Id>037bc0f6-f211-43c5-b006-95feea5fdfb7</d4p1:Id>
            <d4p1:Number>sample string 3</d4p1:Number>
            <d4p1:SortOrder>6</d4p1:SortOrder>
            <d4p1:UseForSms>true</d4p1:UseForSms>
          </d4p1:PhoneNumberModel>
        </d4p1:PhoneNumbers>
        <d4p1:PostalAddresses>
          <d4p1:PostalAddressModel>
            <d4p1:Address1>sample string 3</d4p1:Address1>
            <d4p1:Address2>sample string 4</d4p1:Address2>
            <d4p1:Alias>sample string 2</d4p1:Alias>
            <d4p1:City>sample string 5</d4p1:City>
            <d4p1:CountryCode>sample string 7</d4p1:CountryCode>
            <d4p1:CountryId>583ba77c-13ef-4dce-ab3b-5337fbde1488</d4p1:CountryId>
            <d4p1:CountryName>sample string 8</d4p1:CountryName>
            <d4p1:Default>true</d4p1:Default>
            <d4p1:Id>08e30f78-cbcd-4a72-9e27-0fe64537f13d</d4p1:Id>
            <d4p1:State>sample string 6</d4p1:State>
            <d4p1:Zip>sample string 9</d4p1:Zip>
          </d4p1:PostalAddressModel>
          <d4p1:PostalAddressModel>
            <d4p1:Address1>sample string 3</d4p1:Address1>
            <d4p1:Address2>sample string 4</d4p1:Address2>
            <d4p1:Alias>sample string 2</d4p1:Alias>
            <d4p1:City>sample string 5</d4p1:City>
            <d4p1:CountryCode>sample string 7</d4p1:CountryCode>
            <d4p1:CountryId>583ba77c-13ef-4dce-ab3b-5337fbde1488</d4p1:CountryId>
            <d4p1:CountryName>sample string 8</d4p1:CountryName>
            <d4p1:Default>true</d4p1:Default>
            <d4p1:Id>08e30f78-cbcd-4a72-9e27-0fe64537f13d</d4p1:Id>
            <d4p1:State>sample string 6</d4p1:State>
            <d4p1:Zip>sample string 9</d4p1:Zip>
          </d4p1:PostalAddressModel>
        </d4p1:PostalAddresses>
        <d4p1:Prefix>sample string 6</d4p1:Prefix>
        <d4p1:Suffix>sample string 5</d4p1:Suffix>
      </d2p1:Contact>
      <d2p1:Locations xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Locations>
      <d2p1:Notes>sample string 5</d2p1:Notes>
      <d2p1:Password>sample string 2</d2p1:Password>
      <d2p1:PasswordConfirmation>sample string 3</d2p1:PasswordConfirmation>
      <d2p1:UpDoxId>sample string 6</d2p1:UpDoxId>
      <d2p1:Username>sample string 1</d2p1:Username>
    </d2p1:UserModel>
    <d2p1:UserModel>
      <ExternalId>sample string 8</ExternalId>
      <Id>79003a49-6c48-4e62-9c14-349ae80497df</Id>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Contact xmlns:d4p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Contacts">
        <d4p1:CompanyName>sample string 8</d4p1:CompanyName>
        <d4p1:EmailAddresses>
          <d4p1:EmailAddressModel>
            <d4p1:Address>sample string 3</d4p1:Address>
            <d4p1:Alias>sample string 2</d4p1:Alias>
            <d4p1:Default>true</d4p1:Default>
            <d4p1:Id>b003d6e5-e871-4ad0-bcd3-99fc98401db6</d4p1:Id>
            <d4p1:SortOrder>5</d4p1:SortOrder>
          </d4p1:EmailAddressModel>
          <d4p1:EmailAddressModel>
            <d4p1:Address>sample string 3</d4p1:Address>
            <d4p1:Alias>sample string 2</d4p1:Alias>
            <d4p1:Default>true</d4p1:Default>
            <d4p1:Id>b003d6e5-e871-4ad0-bcd3-99fc98401db6</d4p1:Id>
            <d4p1:SortOrder>5</d4p1:SortOrder>
          </d4p1:EmailAddressModel>
        </d4p1:EmailAddresses>
        <d4p1:FirstName>sample string 2</d4p1:FirstName>
        <d4p1:FullName>sample string 7</d4p1:FullName>
        <d4p1:Id>c8e491fe-3922-4786-9dc8-59187b7214fb</d4p1:Id>
        <d4p1:JobTitle>sample string 9</d4p1:JobTitle>
        <d4p1:LastName>sample string 4</d4p1:LastName>
        <d4p1:MiddleName>sample string 3</d4p1:MiddleName>
        <d4p1:Notes>sample string 10</d4p1:Notes>
        <d4p1:PhoneNumbers>
          <d4p1:PhoneNumberModel>
            <d4p1:Alias>sample string 2</d4p1:Alias>
            <d4p1:Default>true</d4p1:Default>
            <d4p1:Id>037bc0f6-f211-43c5-b006-95feea5fdfb7</d4p1:Id>
            <d4p1:Number>sample string 3</d4p1:Number>
            <d4p1:SortOrder>6</d4p1:SortOrder>
            <d4p1:UseForSms>true</d4p1:UseForSms>
          </d4p1:PhoneNumberModel>
          <d4p1:PhoneNumberModel>
            <d4p1:Alias>sample string 2</d4p1:Alias>
            <d4p1:Default>true</d4p1:Default>
            <d4p1:Id>037bc0f6-f211-43c5-b006-95feea5fdfb7</d4p1:Id>
            <d4p1:Number>sample string 3</d4p1:Number>
            <d4p1:SortOrder>6</d4p1:SortOrder>
            <d4p1:UseForSms>true</d4p1:UseForSms>
          </d4p1:PhoneNumberModel>
        </d4p1:PhoneNumbers>
        <d4p1:PostalAddresses>
          <d4p1:PostalAddressModel>
            <d4p1:Address1>sample string 3</d4p1:Address1>
            <d4p1:Address2>sample string 4</d4p1:Address2>
            <d4p1:Alias>sample string 2</d4p1:Alias>
            <d4p1:City>sample string 5</d4p1:City>
            <d4p1:CountryCode>sample string 7</d4p1:CountryCode>
            <d4p1:CountryId>583ba77c-13ef-4dce-ab3b-5337fbde1488</d4p1:CountryId>
            <d4p1:CountryName>sample string 8</d4p1:CountryName>
            <d4p1:Default>true</d4p1:Default>
            <d4p1:Id>08e30f78-cbcd-4a72-9e27-0fe64537f13d</d4p1:Id>
            <d4p1:State>sample string 6</d4p1:State>
            <d4p1:Zip>sample string 9</d4p1:Zip>
          </d4p1:PostalAddressModel>
          <d4p1:PostalAddressModel>
            <d4p1:Address1>sample string 3</d4p1:Address1>
            <d4p1:Address2>sample string 4</d4p1:Address2>
            <d4p1:Alias>sample string 2</d4p1:Alias>
            <d4p1:City>sample string 5</d4p1:City>
            <d4p1:CountryCode>sample string 7</d4p1:CountryCode>
            <d4p1:CountryId>583ba77c-13ef-4dce-ab3b-5337fbde1488</d4p1:CountryId>
            <d4p1:CountryName>sample string 8</d4p1:CountryName>
            <d4p1:Default>true</d4p1:Default>
            <d4p1:Id>08e30f78-cbcd-4a72-9e27-0fe64537f13d</d4p1:Id>
            <d4p1:State>sample string 6</d4p1:State>
            <d4p1:Zip>sample string 9</d4p1:Zip>
          </d4p1:PostalAddressModel>
        </d4p1:PostalAddresses>
        <d4p1:Prefix>sample string 6</d4p1:Prefix>
        <d4p1:Suffix>sample string 5</d4p1:Suffix>
      </d2p1:Contact>
      <d2p1:Locations xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Locations>
      <d2p1:Notes>sample string 5</d2p1:Notes>
      <d2p1:Password>sample string 2</d2p1:Password>
      <d2p1:PasswordConfirmation>sample string 3</d2p1:PasswordConfirmation>
      <d2p1:UpDoxId>sample string 6</d2p1:UpDoxId>
      <d2p1:Username>sample string 1</d2p1:Username>
    </d2p1:UserModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfUserModelaJigm_Sbl>