Sign in
latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Listings

List listings

List listings 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.
  • earliestDate and latestDate must be >= 0 when provided.
  • latestDate must be greater than or equal to earliestDate when both are provided.
  • agentGuid and createdByGuid must belong to the subscriber when provided.
get/api/files/listings

Query parameters

earliestDateinteger nullable

Unix timestamp (seconds since 1970) for the start of the date range. Must be greater than or equal to 0. Example: 1709251200 for March 1, 2024 00:00 UTC

latestDateinteger nullable

Unix timestamp for the end of the date range. Must be greater than or equal to 0 and must not be earlier than earliestDate. Example: 1711929599 for March 31, 2024 23:59 UTC

agentGuidstring guid nullable

GUID of the agent assigned to the listings. Format: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX Must belong to a known user in the subscriber.

createdByGuidstring guid nullable

GUID of the user who created the listings. Useful for tracking data entry or import sources. Must belong to a known user in the subscriber.

pageNumberinteger nullable

Page number for pagination. Default: 1, Min: 1, Max: 1000 Each page contains 10 items

Response

warningsstring[] nullable