POST api/user/list

Request Information

URI Parameters

None.

Body Parameters

UserListRequest
NameDescriptionTypeAdditional information
Keyword

string

None.
UserIds

Collection of string

None.
Emails

Collection of string

None.
ContactTypes

Collection of string

None.
Page

integer

None.
Size

integer

None.
TotalItems

integer

None.
SortOrder

string

None.
SortField

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "keyword": "sample string 1",
  "userIds": [
    "sample string 1",
    "sample string 2"
  ],
  "emails": [
    "sample string 1",
    "sample string 2"
  ],
  "contactTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "page": 2,
  "size": 3,
  "totalItems": 4,
  "sortOrder": "sample string 5",
  "sortField": "sample string 6"
}

application/octet-stream

Sample: 
{"keyword":"sample string 1","userIds":["sample string 1","sample string 2"],"emails":["sample string 1","sample string 2"],"contactTypes":["sample string 1","sample string 2"],"page":2,"size":3,"totalItems":4,"sortOrder":"sample string 5","sortField":"sample string 6"}

application/xml, text/xml

Sample: 
<UserListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.User.Request">
  <Page xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">2</Page>
  <Size xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">3</Size>
  <SortField xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">sample string 6</SortField>
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">sample string 5</SortOrder>
  <TotalItems xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">4</TotalItems>
  <ContactTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ContactTypes>
  <Emails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Emails>
  <Keyword>sample string 1</Keyword>
  <UserIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </UserIds>
</UserListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseResultOfUserListResponse
NameDescriptionTypeAdditional information
Data

UserListResponse

None.
Message

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "data": {
    "users": [
      {
        "id": "sample string 1",
        "memberNum": "sample string 2",
        "title": "sample string 3",
        "firstName": "sample string 4",
        "lastName": "sample string 5",
        "middleName": "sample string 6",
        "prefName": "sample string 7",
        "registeredEmail": "sample string 8",
        "secondaryEmail": "sample string 9",
        "gender": "sample string 10",
        "pronoun": "sample string 11",
        "dob": "2025-12-11T04:21:54.5027279+11:00",
        "graduationDate": "2025-12-11T04:21:54.5027279+11:00",
        "mobile": "sample string 12",
        "homePhone": "sample string 13",
        "homeAddress1": "sample string 14",
        "homeAddress2": "sample string 15",
        "homeSuburb": "sample string 16",
        "homeState": "sample string 17",
        "homePostcode": "sample string 18",
        "homeCountry": "sample string 19",
        "postalAddress1": "sample string 20",
        "postalAddress2": "sample string 21",
        "postalSuburb": "sample string 22",
        "postalState": "sample string 23",
        "postalPostcode": "sample string 24",
        "postalCountry": "sample string 25",
        "contactTypes": [
          "sample string 1",
          "sample string 2"
        ],
        "isBannedFromCommunity": true,
        "fields": [
          {
            "id": "bd7b1ee0-def0-4dd5-be6f-d814625497af",
            "label": "sample string 2",
            "value": {},
            "toolTip": "sample string 4",
            "type": "sample string 5",
            "isRequired": true,
            "dataCallbackRelativeUrl": "sample string 7"
          },
          {
            "id": "bd7b1ee0-def0-4dd5-be6f-d814625497af",
            "label": "sample string 2",
            "value": {},
            "toolTip": "sample string 4",
            "type": "sample string 5",
            "isRequired": true,
            "dataCallbackRelativeUrl": "sample string 7"
          }
        ],
        "avatarUrl": "sample string 27"
      },
      {
        "id": "sample string 1",
        "memberNum": "sample string 2",
        "title": "sample string 3",
        "firstName": "sample string 4",
        "lastName": "sample string 5",
        "middleName": "sample string 6",
        "prefName": "sample string 7",
        "registeredEmail": "sample string 8",
        "secondaryEmail": "sample string 9",
        "gender": "sample string 10",
        "pronoun": "sample string 11",
        "dob": "2025-12-11T04:21:54.5027279+11:00",
        "graduationDate": "2025-12-11T04:21:54.5027279+11:00",
        "mobile": "sample string 12",
        "homePhone": "sample string 13",
        "homeAddress1": "sample string 14",
        "homeAddress2": "sample string 15",
        "homeSuburb": "sample string 16",
        "homeState": "sample string 17",
        "homePostcode": "sample string 18",
        "homeCountry": "sample string 19",
        "postalAddress1": "sample string 20",
        "postalAddress2": "sample string 21",
        "postalSuburb": "sample string 22",
        "postalState": "sample string 23",
        "postalPostcode": "sample string 24",
        "postalCountry": "sample string 25",
        "contactTypes": [
          "sample string 1",
          "sample string 2"
        ],
        "isBannedFromCommunity": true,
        "fields": [
          {
            "id": "bd7b1ee0-def0-4dd5-be6f-d814625497af",
            "label": "sample string 2",
            "value": {},
            "toolTip": "sample string 4",
            "type": "sample string 5",
            "isRequired": true,
            "dataCallbackRelativeUrl": "sample string 7"
          },
          {
            "id": "bd7b1ee0-def0-4dd5-be6f-d814625497af",
            "label": "sample string 2",
            "value": {},
            "toolTip": "sample string 4",
            "type": "sample string 5",
            "isRequired": true,
            "dataCallbackRelativeUrl": "sample string 7"
          }
        ],
        "avatarUrl": "sample string 27"
      }
    ],
    "page": 1,
    "size": 2,
    "totalItems": 3,
    "sortOrder": "sample string 4",
    "sortField": "sample string 5"
  },
  "message": "sample string 1"
}

application/octet-stream

Sample: 
{"data":{"users":[{"id":"sample string 1","memberNum":"sample string 2","title":"sample string 3","firstName":"sample string 4","lastName":"sample string 5","middleName":"sample string 6","prefName":"sample string 7","registeredEmail":"sample string 8","secondaryEmail":"sample string 9","gender":"sample string 10","pronoun":"sample string 11","dob":"2025-12-11T04:21:54.5027279+11:00","graduationDate":"2025-12-11T04:21:54.5027279+11:00","mobile":"sample string 12","homePhone":"sample string 13","homeAddress1":"sample string 14","homeAddress2":"sample string 15","homeSuburb":"sample string 16","homeState":"sample string 17","homePostcode":"sample string 18","homeCountry":"sample string 19","postalAddress1":"sample string 20","postalAddress2":"sample string 21","postalSuburb":"sample string 22","postalState":"sample string 23","postalPostcode":"sample string 24","postalCountry":"sample string 25","contactTypes":["sample string 1","sample string 2"],"isBannedFromCommunity":true,"fields":[{"id":"bd7b1ee0-def0-4dd5-be6f-d814625497af","label":"sample string 2","value":{},"toolTip":"sample string 4","type":"sample string 5","isRequired":true,"dataCallbackRelativeUrl":"sample string 7"},{"id":"bd7b1ee0-def0-4dd5-be6f-d814625497af","label":"sample string 2","value":{},"toolTip":"sample string 4","type":"sample string 5","isRequired":true,"dataCallbackRelativeUrl":"sample string 7"}],"avatarUrl":"sample string 27"},{"id":"sample string 1","memberNum":"sample string 2","title":"sample string 3","firstName":"sample string 4","lastName":"sample string 5","middleName":"sample string 6","prefName":"sample string 7","registeredEmail":"sample string 8","secondaryEmail":"sample string 9","gender":"sample string 10","pronoun":"sample string 11","dob":"2025-12-11T04:21:54.5027279+11:00","graduationDate":"2025-12-11T04:21:54.5027279+11:00","mobile":"sample string 12","homePhone":"sample string 13","homeAddress1":"sample string 14","homeAddress2":"sample string 15","homeSuburb":"sample string 16","homeState":"sample string 17","homePostcode":"sample string 18","homeCountry":"sample string 19","postalAddress1":"sample string 20","postalAddress2":"sample string 21","postalSuburb":"sample string 22","postalState":"sample string 23","postalPostcode":"sample string 24","postalCountry":"sample string 25","contactTypes":["sample string 1","sample string 2"],"isBannedFromCommunity":true,"fields":[{"id":"bd7b1ee0-def0-4dd5-be6f-d814625497af","label":"sample string 2","value":{},"toolTip":"sample string 4","type":"sample string 5","isRequired":true,"dataCallbackRelativeUrl":"sample string 7"},{"id":"bd7b1ee0-def0-4dd5-be6f-d814625497af","label":"sample string 2","value":{},"toolTip":"sample string 4","type":"sample string 5","isRequired":true,"dataCallbackRelativeUrl":"sample string 7"}],"avatarUrl":"sample string 27"}],"page":1,"size":2,"totalItems":3,"sortOrder":"sample string 4","sortField":"sample string 5"},"message":"sample string 1"}

application/xml, text/xml

Sample: 
<ResponseResultOfUserListResponseBtYhHhLc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Response">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.User.Response">
    <Page xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">1</Page>
    <Size xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">2</Size>
    <SortField xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">sample string 5</SortField>
    <SortOrder xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">sample string 4</SortOrder>
    <TotalItems xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">3</TotalItems>
    <d2p1:Users>
      <d2p1:UserResponse>
        <d2p1:AvatarUrl>sample string 27</d2p1:AvatarUrl>
        <d2p1:ContactTypes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:ContactTypes>
        <d2p1:Dob>2025-12-11T04:21:54.5027279+11:00</d2p1:Dob>
        <d2p1:Fields xmlns:d5p1="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Custom">
          <d5p1:FormField>
            <d5p1:DataCallbackRelativeUrl>sample string 7</d5p1:DataCallbackRelativeUrl>
            <d5p1:Id>bd7b1ee0-def0-4dd5-be6f-d814625497af</d5p1:Id>
            <d5p1:IsRequired>true</d5p1:IsRequired>
            <d5p1:Label>sample string 2</d5p1:Label>
            <d5p1:ToolTip>sample string 4</d5p1:ToolTip>
            <d5p1:Type>sample string 5</d5p1:Type>
            <d5p1:Value />
          </d5p1:FormField>
          <d5p1:FormField>
            <d5p1:DataCallbackRelativeUrl>sample string 7</d5p1:DataCallbackRelativeUrl>
            <d5p1:Id>bd7b1ee0-def0-4dd5-be6f-d814625497af</d5p1:Id>
            <d5p1:IsRequired>true</d5p1:IsRequired>
            <d5p1:Label>sample string 2</d5p1:Label>
            <d5p1:ToolTip>sample string 4</d5p1:ToolTip>
            <d5p1:Type>sample string 5</d5p1:Type>
            <d5p1:Value />
          </d5p1:FormField>
        </d2p1:Fields>
        <d2p1:FirstName>sample string 4</d2p1:FirstName>
        <d2p1:Gender>sample string 10</d2p1:Gender>
        <d2p1:GraduationDate>2025-12-11T04:21:54.5027279+11:00</d2p1:GraduationDate>
        <d2p1:HomeAddress1>sample string 14</d2p1:HomeAddress1>
        <d2p1:HomeAddress2>sample string 15</d2p1:HomeAddress2>
        <d2p1:HomeCountry>sample string 19</d2p1:HomeCountry>
        <d2p1:HomePhone>sample string 13</d2p1:HomePhone>
        <d2p1:HomePostcode>sample string 18</d2p1:HomePostcode>
        <d2p1:HomeState>sample string 17</d2p1:HomeState>
        <d2p1:HomeSuburb>sample string 16</d2p1:HomeSuburb>
        <d2p1:Id>sample string 1</d2p1:Id>
        <d2p1:IsBannedFromCommunity>true</d2p1:IsBannedFromCommunity>
        <d2p1:LastName>sample string 5</d2p1:LastName>
        <d2p1:MemberNum>sample string 2</d2p1:MemberNum>
        <d2p1:MiddleName>sample string 6</d2p1:MiddleName>
        <d2p1:Mobile>sample string 12</d2p1:Mobile>
        <d2p1:PostalAddress1>sample string 20</d2p1:PostalAddress1>
        <d2p1:PostalAddress2>sample string 21</d2p1:PostalAddress2>
        <d2p1:PostalCountry>sample string 25</d2p1:PostalCountry>
        <d2p1:PostalPostcode>sample string 24</d2p1:PostalPostcode>
        <d2p1:PostalState>sample string 23</d2p1:PostalState>
        <d2p1:PostalSuburb>sample string 22</d2p1:PostalSuburb>
        <d2p1:PrefName>sample string 7</d2p1:PrefName>
        <d2p1:Pronoun>sample string 11</d2p1:Pronoun>
        <d2p1:RegisteredEmail>sample string 8</d2p1:RegisteredEmail>
        <d2p1:SecondaryEmail>sample string 9</d2p1:SecondaryEmail>
        <d2p1:Title>sample string 3</d2p1:Title>
      </d2p1:UserResponse>
      <d2p1:UserResponse>
        <d2p1:AvatarUrl>sample string 27</d2p1:AvatarUrl>
        <d2p1:ContactTypes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:ContactTypes>
        <d2p1:Dob>2025-12-11T04:21:54.5027279+11:00</d2p1:Dob>
        <d2p1:Fields xmlns:d5p1="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Custom">
          <d5p1:FormField>
            <d5p1:DataCallbackRelativeUrl>sample string 7</d5p1:DataCallbackRelativeUrl>
            <d5p1:Id>bd7b1ee0-def0-4dd5-be6f-d814625497af</d5p1:Id>
            <d5p1:IsRequired>true</d5p1:IsRequired>
            <d5p1:Label>sample string 2</d5p1:Label>
            <d5p1:ToolTip>sample string 4</d5p1:ToolTip>
            <d5p1:Type>sample string 5</d5p1:Type>
            <d5p1:Value />
          </d5p1:FormField>
          <d5p1:FormField>
            <d5p1:DataCallbackRelativeUrl>sample string 7</d5p1:DataCallbackRelativeUrl>
            <d5p1:Id>bd7b1ee0-def0-4dd5-be6f-d814625497af</d5p1:Id>
            <d5p1:IsRequired>true</d5p1:IsRequired>
            <d5p1:Label>sample string 2</d5p1:Label>
            <d5p1:ToolTip>sample string 4</d5p1:ToolTip>
            <d5p1:Type>sample string 5</d5p1:Type>
            <d5p1:Value />
          </d5p1:FormField>
        </d2p1:Fields>
        <d2p1:FirstName>sample string 4</d2p1:FirstName>
        <d2p1:Gender>sample string 10</d2p1:Gender>
        <d2p1:GraduationDate>2025-12-11T04:21:54.5027279+11:00</d2p1:GraduationDate>
        <d2p1:HomeAddress1>sample string 14</d2p1:HomeAddress1>
        <d2p1:HomeAddress2>sample string 15</d2p1:HomeAddress2>
        <d2p1:HomeCountry>sample string 19</d2p1:HomeCountry>
        <d2p1:HomePhone>sample string 13</d2p1:HomePhone>
        <d2p1:HomePostcode>sample string 18</d2p1:HomePostcode>
        <d2p1:HomeState>sample string 17</d2p1:HomeState>
        <d2p1:HomeSuburb>sample string 16</d2p1:HomeSuburb>
        <d2p1:Id>sample string 1</d2p1:Id>
        <d2p1:IsBannedFromCommunity>true</d2p1:IsBannedFromCommunity>
        <d2p1:LastName>sample string 5</d2p1:LastName>
        <d2p1:MemberNum>sample string 2</d2p1:MemberNum>
        <d2p1:MiddleName>sample string 6</d2p1:MiddleName>
        <d2p1:Mobile>sample string 12</d2p1:Mobile>
        <d2p1:PostalAddress1>sample string 20</d2p1:PostalAddress1>
        <d2p1:PostalAddress2>sample string 21</d2p1:PostalAddress2>
        <d2p1:PostalCountry>sample string 25</d2p1:PostalCountry>
        <d2p1:PostalPostcode>sample string 24</d2p1:PostalPostcode>
        <d2p1:PostalState>sample string 23</d2p1:PostalState>
        <d2p1:PostalSuburb>sample string 22</d2p1:PostalSuburb>
        <d2p1:PrefName>sample string 7</d2p1:PrefName>
        <d2p1:Pronoun>sample string 11</d2p1:Pronoun>
        <d2p1:RegisteredEmail>sample string 8</d2p1:RegisteredEmail>
        <d2p1:SecondaryEmail>sample string 9</d2p1:SecondaryEmail>
        <d2p1:Title>sample string 3</d2p1:Title>
      </d2p1:UserResponse>
    </d2p1:Users>
  </Data>
  <Message>sample string 1</Message>
</ResponseResultOfUserListResponseBtYhHhLc>