Sign in
latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Sales

List sales

List sales for the current subscriber with optional filters. If pageNumber is greater than 1 and no results are found, the endpoint returns 422.

Validation & Requirements

Required Parameters

  • None

Required JSON Body Fields

  • None

Validations

  • Invalid GUID values in *Guid/*Guids fields return 422 Unprocessable Entity.
  • Invalid date values in *date* fields return 422 Unprocessable Entity.
  • Missing required request body returns 422 Unprocessable Entity with Missing request body..
  • Additional business-rule validation may return 422 with details in the errors array.
get/api/files/sales/fields

Query parameters

mlsStatusinteger nullable

Optional MLS status filter.

sourceIdinteger nullable

Optional source ID filter.

checklistTypestring nullable

Optional checklist type filter.

saleTypestring nullable

Optional sale type filter.

listingIdinteger nullable

Optional listing ID filter.

saleIdinteger nullable

Optional sale ID filter.

userBeingImpersonatedinteger nullable

Optional impersonated user ID context.