Skip to main content
GET
/
api
/
v1
/
secure
/
listing-status
/
{listing_id}
Get Listing Status
curl --request GET \
  --url https://padsplit.fairsentry.com/api/v1/secure/listing-status/{listing_id} \
  --header 'X-API-Key: <api-key>'
{
  "listing_id": "<string>",
  "compliant": true,
  "inactive": true,
  "noncompliant_since": "<string>",
  "noncompliant_sections": [
    "<string>"
  ],
  "violation_categories": [
    "<string>"
  ],
  "violation_summaries": [
    "<string>"
  ],
  "severity": 123
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
listing_id
string
required

Response

Successful Response

​
listing_id
string
required

The unique identifier for the listing.

​
compliant
boolean
required

Whether the listing, based on the most recent compliance check, is currently potentiallycompliant with fair housing laws.

​
inactive
boolean
required

Whether the listing is marked inactive or not.

​
noncompliant_since
string | null

The date when the listing became potentially non-compliant, if applicable.

​
noncompliant_sections
string[] | null

The section_type's of the listing that are potentially non-compliant, if any.

​
violation_categories
string[] | null

The categories of potential violations found in the listing, if any.

​
violation_summaries
string[] | null

Summaries of the potential violations found in the listing, if any.

​
severity
integer | null

The maximum severity level of the potential violations found in the listing, if any.