GET api/globalsearch/auctions

Search for Actions across the system. Processes this global search API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
Term	The term value.	string	None.
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
BranchId	The unique identifier of the related branch resource.	integer	None.
GroupTypes	The collection of group types.	Collection of GroupSearchType	None.
ExcludeDeleted	Indicates whether exclude deleted is true.	boolean	None.
ExcludeArchived	Indicates whether exclude archived is true.	boolean	None.
LastUpdated	The last updated, expressed as a date and time.	date	None.
ServiceType	The service type value.	string	None.
PaginationLastDocumentId	The unique identifier of the related pagination last document resource.	integer	None.

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

PagedCollectionDataContractOfGlobalSearchAuctionResultDataContract

Name	Description	Type	Additional information
TotalCount	The total count value.	integer	None.
CurrentCount	The current count value.	integer	None.
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
Collection	The collection of collection.	Collection of GlobalSearchAuctionResultDataContract	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "AuctionDate": "2026-08-05T01:25:44.8461117Z",
      "PrimaryGroupMember": {
        "Id": 1,
        "GroupId": 2,
        "Title": "sample string 3",
        "Name": "sample string 4",
        "EmailAddress": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "Telephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        }
      },
      "PropertyAddress": "sample string 2",
      "NumberOfLots": 3,
      "LastUpdated": "2026-08-05T01:25:44.8461117Z",
      "Id": 4
    },
    {
      "AuctionDate": "2026-08-05T01:25:44.8461117Z",
      "PrimaryGroupMember": {
        "Id": 1,
        "GroupId": 2,
        "Title": "sample string 3",
        "Name": "sample string 4",
        "EmailAddress": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "Telephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        }
      },
      "PropertyAddress": "sample string 2",
      "NumberOfLots": 3,
      "LastUpdated": "2026-08-05T01:25:44.8461117Z",
      "Id": 4
    }
  ]
}